@zeniai/client-epic-state 5.1.49 → 5.1.50-betaAK0

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

@@ -0,0 +1,77 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initializeInvoicingSubscriptionAddress = exports.resetEditInvoicingSubscriptionDetailView = exports.submitInvoicingSubscriptionFormFailure = exports.submitInvoicingSubscriptionFormSuccess = exports.submitInvoicingSubscriptionForm = exports.updateInvoicingSubscriptionFormDraft = exports.fetchInvoicingSubscriptionFormPage = exports.initialState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const invoicingSubscriptionFormConfig_1 = require("./invoicingSubscriptionFormConfig");
+exports.initialState = {
+    fetchState: 'Not-Started',
+    error: undefined,
+    editDraftById: {},
+    newSubscriptionDraft: { ...invoicingSubscriptionFormConfig_1.initialInvoicingSubscriptionFormLocalData },
+    savedSubscriptionId: undefined,
+    hasValidState() {
+        return this.fetchState === 'Completed';
+    },
+};
+const editInvoicingSubscriptionDetailView = (0, toolkit_1.createSlice)({
+    name: 'editInvoicingSubscriptionDetailView',
+    initialState: exports.initialState,
+    reducers: {
+        fetchInvoicingSubscriptionFormPage: {
+            reducer() {
+                // No state mutation; the aggregator epic fans out the option-list
+                // and subscription-detail fetches in response to this action.
+            },
+            prepare(payload) {
+                return { payload: { subscriptionId: payload.subscriptionId } };
+            },
+        },
+        updateInvoicingSubscriptionFormDraft(draft, action) {
+            const { id, localData } = action.payload;
+            if (id != null) {
+                draft.editDraftById[id] = localData;
+            }
+            else {
+                draft.newSubscriptionDraft = localData;
+            }
+        },
+        submitInvoicingSubscriptionForm: {
+            reducer(draft) {
+                draft.fetchState = 'In-Progress';
+                draft.error = undefined;
+                draft.savedSubscriptionId = undefined;
+            },
+            prepare(payload) {
+                return { payload };
+            },
+        },
+        submitInvoicingSubscriptionFormSuccess(draft, action) {
+            draft.fetchState = 'Completed';
+            draft.error = undefined;
+            draft.savedSubscriptionId = action.payload.subscriptionId;
+        },
+        submitInvoicingSubscriptionFormFailure(draft, action) {
+            draft.fetchState = 'Error';
+            draft.error = action.payload;
+        },
+        resetEditInvoicingSubscriptionDetailView(draft) {
+            draft.fetchState = 'Not-Started';
+            draft.error = undefined;
+            draft.savedSubscriptionId = undefined;
+            draft.editDraftById = {};
+            draft.newSubscriptionDraft = {
+                ...invoicingSubscriptionFormConfig_1.initialInvoicingSubscriptionFormLocalData,
+            };
+        },
+        // Trigger only — handled by initializeInvoicingSubscriptionAddressEpic.
+        initializeInvoicingSubscriptionAddress: {
+            reducer() { },
+            prepare(payload) {
+                return { payload };
+            },
+        },
+    },
+});
+_a = editInvoicingSubscriptionDetailView.actions, exports.fetchInvoicingSubscriptionFormPage = _a.fetchInvoicingSubscriptionFormPage, exports.updateInvoicingSubscriptionFormDraft = _a.updateInvoicingSubscriptionFormDraft, exports.submitInvoicingSubscriptionForm = _a.submitInvoicingSubscriptionForm, exports.submitInvoicingSubscriptionFormSuccess = _a.submitInvoicingSubscriptionFormSuccess, exports.submitInvoicingSubscriptionFormFailure = _a.submitInvoicingSubscriptionFormFailure, exports.resetEditInvoicingSubscriptionDetailView = _a.resetEditInvoicingSubscriptionDetailView, exports.initializeInvoicingSubscriptionAddress = _a.initializeInvoicingSubscriptionAddress;
+exports.default = editInvoicingSubscriptionDetailView.reducer;

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

@@ -0,0 +1,41 @@
+import { ID } from '../../../commonStateTypes/common';
+import { SelectorView } from '../../../commonStateTypes/viewAndReport/viewAndReport';
+import { InvoicingCoupon } from '../../../entity/invoicing/coupon/couponState';
+import { InvoicingCustomer } from '../../../entity/invoicing/invoicingCustomer/invoicingCustomerState';
+import { InvoicingSubscription } from '../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionState';
+import { InvoicingPlan } from '../../../entity/invoicing/plan/planState';
+import { InvoicingProduct } from '../../../entity/invoicing/product/productState';
+import { RootState } from '../../../reducer';
+import { InvoicingSubscriptionFormLocalData } from './editInvoicingSubscriptionDetailViewState';
+/**
+ * Bundled view for the subscription create/edit form's save concern: the save
+ * fetch state/error, the id of the subscription last saved, and — when an
+ * `invoicingSubscriptionID` is passed (edit mode) — the existing subscription to
+ * prefill the form.
+ */
+export interface EditInvoicingSubscriptionDetailView extends SelectorView {
+    savedSubscriptionId?: ID;
+    subscription?: InvoicingSubscription;
+}
+/**
+ * The full data the subscription form screen needs in one selector: the draft
+ * `localData` (seeded from the existing subscription in edit mode until the user
+ * edits), the shipping-address label (from the shared Address screen), the
+ * canonical billing-frequency value set, the raw option lists (customers, plans,
+ * products, coupons), and the save state. The screen maps the raw lists/values
+ * to its own option shapes, so this stays free of any web-components dependency.
+ */
+export interface InvoicingSubscriptionFormView extends SelectorView {
+    billingFrequencyValues: string[];
+    coupons: InvoicingCoupon[];
+    customers: InvoicingCustomer[];
+    localData: InvoicingSubscriptionFormLocalData;
+    mode: 'create' | 'edit';
+    plans: InvoicingPlan[];
+    products: InvoicingProduct[];
+    savedSubscriptionId?: ID;
+    shippingAddressLabel?: string;
+    subscription?: InvoicingSubscription;
+}
+export declare const getEditInvoicingSubscriptionDetailViewState: (state: RootState, invoicingSubscriptionID?: ID) => EditInvoicingSubscriptionDetailView;
+export declare const getInvoicingSubscriptionFormView: (state: RootState, invoicingSubscriptionID?: ID) => InvoicingSubscriptionFormView;

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

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInvoicingSubscriptionFormView = exports.getEditInvoicingSubscriptionDetailViewState = void 0;
+const invoicingSubscriptionSelector_1 = require("../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionSelector");
+const addressViewSelector_1 = require("../../addressView/addressViewSelector");
+const couponViewSelector_1 = require("../couponView/couponViewSelector");
+const invoicingCatalogListViewSelector_1 = require("../invoicingCatalogListView/invoicingCatalogListViewSelector");
+const invoicingCustomerListViewSelector_1 = require("../invoicingCustomerListView/invoicingCustomerListViewSelector");
+const invoicingSubscriptionFormConfig_1 = require("./invoicingSubscriptionFormConfig");
+const getEditInvoicingSubscriptionDetailViewState = (state, invoicingSubscriptionID) => {
+    const { error, fetchState, savedSubscriptionId } = state.editInvoicingSubscriptionDetailViewState;
+    return {
+        subscription: invoicingSubscriptionID != null
+            ? (0, invoicingSubscriptionSelector_1.getInvoicingSubscriptionById)(state.invoicingSubscriptionState, invoicingSubscriptionID)
+            : undefined,
+        savedSubscriptionId,
+        fetchState,
+        error,
+        version: 1.0,
+    };
+};
+exports.getEditInvoicingSubscriptionDetailViewState = getEditInvoicingSubscriptionDetailViewState;
+const getInvoicingSubscriptionFormView = (state, invoicingSubscriptionID) => {
+    const { editDraftById, error, fetchState, newSubscriptionDraft, savedSubscriptionId } = state.editInvoicingSubscriptionDetailViewState;
+    const mode = invoicingSubscriptionID != null ? 'edit' : 'create';
+    const subscription = invoicingSubscriptionID != null
+        ? (0, invoicingSubscriptionSelector_1.getInvoicingSubscriptionById)(state.invoicingSubscriptionState, invoicingSubscriptionID)
+        : undefined;
+    const localData = invoicingSubscriptionID != null
+        ? (editDraftById[invoicingSubscriptionID] ??
+            (0, invoicingSubscriptionFormConfig_1.entityToInvoicingSubscriptionFormLocalData)(subscription))
+        : newSubscriptionDraft;
+    // Shipping address is captured via the shared Address screen and seeded there
+    // (from the subscription's inline shipping address) on detail load, so the
+    // formatted label comes from that draft via the shared `getFormattedAddress`.
+    const newAddress = state.addressViewState.newAddressState?.[invoicingSubscriptionFormConfig_1.INVOICING_SUBSCRIPTION_SHIPPING_ADDRESS_TYPE];
+    const shippingAddressLabel = newAddress?.addressToCreate != null
+        ? (0, addressViewSelector_1.getFormattedAddress)(newAddress.addressToCreate)
+        : undefined;
+    const catalogListView = (0, invoicingCatalogListViewSelector_1.getInvoicingCatalogListView)(state);
+    return {
+        billingFrequencyValues: [...invoicingSubscriptionFormConfig_1.INVOICING_SUBSCRIPTION_BILLING_FREQUENCY_VALUES],
+        coupons: (0, couponViewSelector_1.getInvoicingCouponListItems)(state),
+        customers: (0, invoicingCustomerListViewSelector_1.getInvoicingCustomerListView)(state).customers,
+        localData,
+        mode,
+        plans: catalogListView.plans,
+        products: catalogListView.products,
+        savedSubscriptionId,
+        shippingAddressLabel,
+        subscription,
+        fetchState,
+        error,
+        version: 1.0,
+    };
+};
+exports.getInvoicingSubscriptionFormView = getInvoicingSubscriptionFormView;

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

@@ -0,0 +1,26 @@
+import { FetchedState, ID } from '../../../commonStateTypes/common';
+/**
+ * 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).
+ * The shipping address is NOT part of this draft — it is captured via the shared
+ * Address screen (`addressView`) and threaded into the save payload as
+ * `shipping_address` by the save epic.
+ */
+export interface InvoicingSubscriptionFormLocalData {
+    addonIds: string[];
+    autoCollection: boolean;
+    billingFrequency: string;
+    chargeIds: string[];
+    couponId: string;
+    customerId: string;
+    planId: string;
+    poNumber: string;
+    preferredCurrencyCode: string;
+    setupFee: string;
+    trialEnd: string;
+}
+export interface EditInvoicingSubscriptionDetailViewState extends FetchedState {
+    editDraftById: Record<ID, InvoicingSubscriptionFormLocalData>;
+    newSubscriptionDraft: InvoicingSubscriptionFormLocalData;
+    savedSubscriptionId?: ID;
+}

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,20 @@
+import { ActionsObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { fetchInvoicingCouponList } from '../couponView/couponViewReducer';
+import { fetchInvoicingCatalogPlanList } from '../invoicingCatalogListView/invoicingCatalogListViewReducer';
+import { fetchInvoicingCustomerList } from '../invoicingCustomerListView/invoicingCustomerListViewReducer';
+import { fetchInvoicingSubscriptionDetail } from '../invoicingSubscriptionDetailView/invoicingSubscriptionDetailViewReducer';
+import { fetchInvoicingSubscriptionFormPage } from './editInvoicingSubscriptionDetailViewReducer';
+/**
+ * Every action this epic can emit, plus the trigger it listens for. Wired into
+ * the root action union for this view.
+ */
+export type ActionType = ReturnType<typeof fetchInvoicingSubscriptionFormPage> | ReturnType<typeof fetchInvoicingCustomerList> | ReturnType<typeof fetchInvoicingCatalogPlanList> | ReturnType<typeof fetchInvoicingCouponList> | ReturnType<typeof fetchInvoicingSubscriptionDetail>;
+/**
+ * Orchestrates the subscription create/edit form: on
+ * `fetchInvoicingSubscriptionFormPage`, fans out the option-list fetches
+ * (customers, plans, coupons) the form's dropdowns need, plus the subscription
+ * detail fetch when editing an existing subscription. Blind fan-out — the form
+ * always refreshes its option lists, matching the prior screen behavior.
+ */
+export declare const fetchInvoicingSubscriptionFormPageEpic: (actions$: ActionsObservable<ActionType>) => Observable<ActionType>;

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

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchInvoicingSubscriptionFormPageEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const couponViewReducer_1 = require("../couponView/couponViewReducer");
+const invoicingCatalogListViewReducer_1 = require("../invoicingCatalogListView/invoicingCatalogListViewReducer");
+const invoicingCustomerListViewReducer_1 = require("../invoicingCustomerListView/invoicingCustomerListViewReducer");
+const invoicingSubscriptionDetailViewReducer_1 = require("../invoicingSubscriptionDetailView/invoicingSubscriptionDetailViewReducer");
+const editInvoicingSubscriptionDetailViewReducer_1 = require("./editInvoicingSubscriptionDetailViewReducer");
+/**
+ * Orchestrates the subscription create/edit form: on
+ * `fetchInvoicingSubscriptionFormPage`, fans out the option-list fetches
+ * (customers, plans, coupons) the form's dropdowns need, plus the subscription
+ * detail fetch when editing an existing subscription. Blind fan-out — the form
+ * always refreshes its option lists, matching the prior screen behavior.
+ */
+const fetchInvoicingSubscriptionFormPageEpic = (actions$) => actions$.pipe((0, operators_1.filter)(editInvoicingSubscriptionDetailViewReducer_1.fetchInvoicingSubscriptionFormPage.match), (0, operators_1.mergeMap)((action) => {
+    const { subscriptionId } = action.payload;
+    const pageActions = [
+        (0, invoicingCustomerListViewReducer_1.fetchInvoicingCustomerList)({ filters: {}, keepExistingListItems: false }),
+        (0, invoicingCatalogListViewReducer_1.fetchInvoicingCatalogPlanList)({
+            filters: {},
+            keepExistingListItems: false,
+        }),
+        (0, couponViewReducer_1.fetchInvoicingCouponList)({ filters: {}, keepExistingListItems: false }),
+    ];
+    if (subscriptionId != null) {
+        pageActions.push((0, invoicingSubscriptionDetailViewReducer_1.fetchInvoicingSubscriptionDetail)({ id: subscriptionId }));
+    }
+    return (0, rxjs_1.concat)((0, rxjs_1.from)(pageActions));
+}));
+exports.fetchInvoicingSubscriptionFormPageEpic = fetchInvoicingSubscriptionFormPageEpic;

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

@@ -0,0 +1,16 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { RootState } from '../../../reducer';
+import { newAddressInLocalStore } from '../../addressView/addressViewReducer';
+import { updateInvoicingSubscriptionDetail } from '../invoicingSubscriptionDetailView/invoicingSubscriptionDetailViewReducer';
+import { initializeInvoicingSubscriptionAddress } from './editInvoicingSubscriptionDetailViewReducer';
+export type ActionType = ReturnType<typeof initializeInvoicingSubscriptionAddress> | ReturnType<typeof updateInvoicingSubscriptionDetail> | ReturnType<typeof newAddressInLocalStore>;
+/**
+ * Seed the shared Address screen with an existing subscription's saved shipping
+ * address (carried inline on the subscription entity as `shippingAddress`).
+ * Runs both when the subscription detail loads and on an explicit initialize
+ * trigger. Skips when an in-progress draft already exists, so an address the
+ * user just entered survives navigating between the form and the Address screen.
+ * Mirrors `initializeInvoicingCustomerAddressEpic`.
+ */
+export declare const initializeInvoicingSubscriptionAddressEpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>) => Observable<ActionType>;

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

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initializeInvoicingSubscriptionAddressEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const invoicingSubscriptionSelector_1 = require("../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionSelector");
+const addressViewReducer_1 = require("../../addressView/addressViewReducer");
+const invoicingSubscriptionDetailViewReducer_1 = require("../invoicingSubscriptionDetailView/invoicingSubscriptionDetailViewReducer");
+const editInvoicingSubscriptionDetailViewReducer_1 = require("./editInvoicingSubscriptionDetailViewReducer");
+const invoicingSubscriptionFormConfig_1 = require("./invoicingSubscriptionFormConfig");
+/**
+ * Seed the shared Address screen with an existing subscription's saved shipping
+ * address (carried inline on the subscription entity as `shippingAddress`).
+ * Runs both when the subscription detail loads and on an explicit initialize
+ * trigger. Skips when an in-progress draft already exists, so an address the
+ * user just entered survives navigating between the form and the Address screen.
+ * Mirrors `initializeInvoicingCustomerAddressEpic`.
+ */
+const initializeInvoicingSubscriptionAddressEpic = (actions$, state$) => actions$.pipe((0, operators_1.filter)((action) => editInvoicingSubscriptionDetailViewReducer_1.initializeInvoicingSubscriptionAddress.match(action) ||
+    invoicingSubscriptionDetailViewReducer_1.updateInvoicingSubscriptionDetail.match(action)), (0, operators_1.mergeMap)((action) => {
+    const { id } = action.payload;
+    const rootState = state$.value;
+    const existingDraft = rootState.addressViewState.newAddressState?.[invoicingSubscriptionFormConfig_1.INVOICING_SUBSCRIPTION_SHIPPING_ADDRESS_TYPE]?.addressToCreate;
+    if (existingDraft != null || id == null) {
+        return rxjs_1.EMPTY;
+    }
+    const subscription = (0, invoicingSubscriptionSelector_1.getInvoicingSubscriptionById)(rootState.invoicingSubscriptionState, id);
+    return subscription?.shippingAddress != null
+        ? (0, rxjs_1.of)((0, addressViewReducer_1.newAddressInLocalStore)({
+            addressType: invoicingSubscriptionFormConfig_1.INVOICING_SUBSCRIPTION_SHIPPING_ADDRESS_TYPE,
+            addressToCreate: (0, invoicingSubscriptionFormConfig_1.invoicingShippingAddressToAddressUpdatableInfo)(subscription.shippingAddress),
+        }))
+        : rxjs_1.EMPTY;
+}));
+exports.initializeInvoicingSubscriptionAddressEpic = initializeInvoicingSubscriptionAddressEpic;

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

@@ -0,0 +1,33 @@
+import { InvoicingBillingAddressPayload } from '../../../entity/invoicing/invoicingCommonPayload';
+import { InvoicingSubscription } from '../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionState';
+import { AddressUpdatableInfo } from '../../addressView/addressViewState';
+import { InvoicingSubscriptionFormLocalData } from './editInvoicingSubscriptionDetailViewState';
+/** `AddressType` key used when the subscription form opens the shared Address screen. */
+export declare 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 declare const INVOICING_SUBSCRIPTION_BILLING_FREQUENCY_VALUES: readonly ["weekly", "monthly", "quarterly", "half_yearly", "yearly"];
+/** Map a billing-frequency value to its API `billing_period` / `billing_period_unit`. */
+export declare const billingFrequencyToPeriod: (value: string) => {
+    period: number;
+    unit: string;
+};
+/** Map an existing subscription's period/unit back to a billing-frequency value. */
+export declare const periodToBillingFrequency: (period?: number, unit?: string) => string;
+export declare const initialInvoicingSubscriptionFormLocalData: InvoicingSubscriptionFormLocalData;
+/** Seed the form draft from an existing subscription entity (edit mode). */
+export declare const entityToInvoicingSubscriptionFormLocalData: (subscription?: InvoicingSubscription) => InvoicingSubscriptionFormLocalData;
+/**
+ * Convert the shared Address screen's `AddressUpdatableInfo` into the invoicing
+ * shipping-address payload shape the subscription API expects
+ * (`line1`/`line2`/`city`/`state_code`/`zip`/`country`).
+ */
+export declare const addressUpdatableInfoToInvoicingShippingPayload: (info: AddressUpdatableInfo) => InvoicingBillingAddressPayload;
+/**
+ * Convert an existing subscription's shipping-address payload into the shared
+ * Address screen's `AddressUpdatableInfo` (used to seed the screen on edit).
+ */
+export declare const invoicingShippingAddressToAddressUpdatableInfo: (address: InvoicingBillingAddressPayload) => AddressUpdatableInfo;

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

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.invoicingShippingAddressToAddressUpdatableInfo = exports.addressUpdatableInfoToInvoicingShippingPayload = exports.entityToInvoicingSubscriptionFormLocalData = exports.initialInvoicingSubscriptionFormLocalData = exports.periodToBillingFrequency = exports.billingFrequencyToPeriod = exports.INVOICING_SUBSCRIPTION_BILLING_FREQUENCY_VALUES = exports.INVOICING_SUBSCRIPTION_SHIPPING_ADDRESS_TYPE = void 0;
+/** `AddressType` key used when the subscription form opens the shared Address screen. */
+exports.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).
+ */
+exports.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`. */
+const billingFrequencyToPeriod = (value) => BILLING_FREQUENCY_TO_PERIOD[value] ?? BILLING_FREQUENCY_TO_PERIOD.monthly;
+exports.billingFrequencyToPeriod = billingFrequencyToPeriod;
+/** Map an existing subscription's period/unit back to a billing-frequency value. */
+const periodToBillingFrequency = (period, unit) => {
+    const match = exports.INVOICING_SUBSCRIPTION_BILLING_FREQUENCY_VALUES.find((value) => {
+        const mapped = BILLING_FREQUENCY_TO_PERIOD[value];
+        return mapped.period === period && mapped.unit === unit;
+    });
+    return match ?? 'monthly';
+};
+exports.periodToBillingFrequency = periodToBillingFrequency;
+const subscriptionItemIds = (subscription, itemType) => subscription?.subscriptionItems
+    ?.filter((item) => item.itemType === itemType)
+    .map((item) => item.itemPriceID ?? item.catalogItemID)
+    .filter((id) => id != null && id !== '') ?? [];
+exports.initialInvoicingSubscriptionFormLocalData = {
+    addonIds: [],
+    autoCollection: true,
+    billingFrequency: 'monthly',
+    chargeIds: [],
+    couponId: '',
+    customerId: '',
+    planId: '',
+    poNumber: '',
+    preferredCurrencyCode: 'USD',
+    setupFee: '',
+    trialEnd: '',
+};
+/** Seed the form draft from an existing subscription entity (edit mode). */
+const entityToInvoicingSubscriptionFormLocalData = (subscription) => {
+    if (subscription == null) {
+        return { ...exports.initialInvoicingSubscriptionFormLocalData };
+    }
+    return {
+        addonIds: subscriptionItemIds(subscription, 'addon'),
+        autoCollection: (subscription.autoCollection ?? 'on') === 'on',
+        billingFrequency: (0, exports.periodToBillingFrequency)(subscription.billingPeriod, subscription.billingPeriodUnit),
+        chargeIds: subscriptionItemIds(subscription, 'charge'),
+        couponId: subscription.coupons?.[0]?.couponID ?? '',
+        customerId: subscription.customerID ?? '',
+        planId: subscription.planID ?? '',
+        poNumber: subscription.poNumber ?? '',
+        preferredCurrencyCode: subscription.currencyCode ?? 'USD',
+        setupFee: '',
+        trialEnd: subscription.trialEnd != null
+            ? subscription.trialEnd.format('YYYY-MM-DD')
+            : '',
+    };
+};
+exports.entityToInvoicingSubscriptionFormLocalData = entityToInvoicingSubscriptionFormLocalData;
+const trimOrUndefined = (value) => value != null && value.trim() !== '' ? value.trim() : undefined;
+/**
+ * Convert the shared Address screen's `AddressUpdatableInfo` into the invoicing
+ * shipping-address payload shape the subscription API expects
+ * (`line1`/`line2`/`city`/`state_code`/`zip`/`country`).
+ */
+const addressUpdatableInfoToInvoicingShippingPayload = (info) => ({
+    city: trimOrUndefined(info.city),
+    country: trimOrUndefined(info.country),
+    line1: trimOrUndefined(info.street?.[0]),
+    line2: trimOrUndefined(info.street?.[1]),
+    state_code: trimOrUndefined(info.state),
+    zip: trimOrUndefined(info.postalCode),
+});
+exports.addressUpdatableInfoToInvoicingShippingPayload = addressUpdatableInfoToInvoicingShippingPayload;
+/**
+ * Convert an existing subscription's shipping-address payload into the shared
+ * Address screen's `AddressUpdatableInfo` (used to seed the screen on edit).
+ */
+const invoicingShippingAddressToAddressUpdatableInfo = (address) => ({
+    city: address.city ?? '',
+    country: address.country ?? '',
+    postalCode: address.zip ?? '',
+    state: address.state_code ?? '',
+    street: [address.line1, address.line2].filter((part) => part != null && part !== ''),
+    ...(address.country != null ? { countryCode: address.country } : {}),
+});
+exports.invoicingShippingAddressToAddressUpdatableInfo = invoicingShippingAddressToAddressUpdatableInfo;

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

@@ -0,0 +1,9 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { updateInvoicingSubscriptions } from '../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionReducer';
+import { RootState } from '../../../reducer';
+import { ZeniAPI } from '../../../zeniAPI';
+import { resetNewAddressDataInLocalStore } from '../../addressView/addressViewReducer';
+import { submitInvoicingSubscriptionForm, submitInvoicingSubscriptionFormFailure, submitInvoicingSubscriptionFormSuccess } from './editInvoicingSubscriptionDetailViewReducer';
+export type ActionType = ReturnType<typeof submitInvoicingSubscriptionForm> | ReturnType<typeof submitInvoicingSubscriptionFormSuccess> | ReturnType<typeof submitInvoicingSubscriptionFormFailure> | ReturnType<typeof resetNewAddressDataInLocalStore> | ReturnType<typeof updateInvoicingSubscriptions>;
+export declare const saveInvoicingSubscriptionEpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;

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

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.saveInvoicingSubscriptionEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const invoicingSubscriptionReducer_1 = require("../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionReducer");
+const responsePayload_1 = require("../../../responsePayload");
+const addressViewReducer_1 = require("../../addressView/addressViewReducer");
+const editInvoicingSubscriptionDetailViewPayload_1 = require("./editInvoicingSubscriptionDetailViewPayload");
+const invoicingSubscriptionFormConfig_1 = require("./invoicingSubscriptionFormConfig");
+const editInvoicingSubscriptionDetailViewReducer_1 = require("./editInvoicingSubscriptionDetailViewReducer");
+const saveInvoicingSubscriptionEpic = (actions$, state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(editInvoicingSubscriptionDetailViewReducer_1.submitInvoicingSubscriptionForm.match), (0, operators_1.mergeMap)((action) => {
+    const { id } = action.payload;
+    const rootState = state$.value;
+    const viewState = rootState.editInvoicingSubscriptionDetailViewState;
+    const localData = (id != null
+        ? viewState.editDraftById[id]
+        : 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).
+    const shippingAddress = rootState.addressViewState.newAddressState?.[invoicingSubscriptionFormConfig_1.INVOICING_SUBSCRIPTION_SHIPPING_ADDRESS_TYPE]?.addressToCreate;
+    const data = (0, editInvoicingSubscriptionDetailViewPayload_1.localDataToSaveInvoicingSubscriptionPayload)(localData, shippingAddress);
+    const baseUrl = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0`;
+    const request$ = id != null
+        ? zeniAPI.putAndGetJSON(`${baseUrl}/subscriptions/${encodeURIComponent(id)}`, { ...data })
+        : zeniAPI.postAndGetJSON(`${baseUrl}/subscriptions`, { ...data });
+    return request$.pipe((0, operators_1.mergeMap)((response) => {
+        if ((0, responsePayload_1.isSuccessResponse)(response) && response.data != null) {
+            return [
+                (0, invoicingSubscriptionReducer_1.updateInvoicingSubscriptions)([response.data], 'merge'),
+                (0, editInvoicingSubscriptionDetailViewReducer_1.submitInvoicingSubscriptionFormSuccess)({
+                    subscriptionId: response.data.id,
+                }),
+                // Clear the stashed address so the next subscription starts fresh.
+                (0, addressViewReducer_1.resetNewAddressDataInLocalStore)(invoicingSubscriptionFormConfig_1.INVOICING_SUBSCRIPTION_SHIPPING_ADDRESS_TYPE),
+            ];
+        }
+        return (0, rxjs_1.of)((0, editInvoicingSubscriptionDetailViewReducer_1.submitInvoicingSubscriptionFormFailure)(response.status));
+    }), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, editInvoicingSubscriptionDetailViewReducer_1.submitInvoicingSubscriptionFormFailure)((0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Save subscription REST API call errored out ' +
+        JSON.stringify(error))))));
+}));
+exports.saveInvoicingSubscriptionEpic = saveInvoicingSubscriptionEpic;

package/lib/view/invoicing/invoiceAction/invoiceActionEpic.d.ts

@@ -0,0 +1,9 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { updateInvoices } from '../../../entity/invoicing/invoice/invoiceReducer';
+import { RootState } from '../../../reducer';
+import { ZeniAPI } from '../../../zeniAPI';
+import { runInvoicingInvoiceAction, runInvoicingInvoiceActionFailure, runInvoicingInvoiceActionSuccess, updateInvoicingInvoice } from './invoiceActionReducer';
+export type ActionType = ReturnType<typeof runInvoicingInvoiceAction> | ReturnType<typeof runInvoicingInvoiceActionSuccess> | ReturnType<typeof runInvoicingInvoiceActionFailure> | ReturnType<typeof updateInvoicingInvoice> | ReturnType<typeof updateInvoices>;
+export declare const runInvoicingInvoiceActionEpic: (actions$: ActionsObservable<ActionType>, _state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;
+export declare const updateInvoicingInvoiceEpic: (actions$: ActionsObservable<ActionType>, _state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;

package/lib/view/invoicing/invoiceAction/invoiceActionEpic.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateInvoicingInvoiceEpic = exports.runInvoicingInvoiceActionEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const invoiceReducer_1 = require("../../../entity/invoicing/invoice/invoiceReducer");
+const responsePayload_1 = require("../../../responsePayload");
+const invoiceActionReducer_1 = require("./invoiceActionReducer");
+const runInvoicingInvoiceActionEpic = (actions$, _state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(invoiceActionReducer_1.runInvoicingInvoiceAction.match), (0, operators_1.mergeMap)((action) => {
+    const { action: kind, body, invoiceId } = action.payload;
+    const apiUrl = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0/invoices/${encodeURIComponent(invoiceId)}/${kind}`;
+    return zeniAPI
+        .postAndGetJSON(apiUrl, (body ?? {}))
+        .pipe((0, operators_1.mergeMap)((response) => {
+        if ((0, responsePayload_1.isSuccessResponse)(response) && response.data != null) {
+            return [
+                (0, invoiceReducer_1.updateInvoices)([response.data], 'merge'),
+                (0, invoiceActionReducer_1.runInvoicingInvoiceActionSuccess)({ invoiceId }),
+            ];
+        }
+        return (0, rxjs_1.of)((0, invoiceActionReducer_1.runInvoicingInvoiceActionFailure)({
+            error: response.status,
+            invoiceId,
+        }));
+    }), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, invoiceActionReducer_1.runInvoicingInvoiceActionFailure)({
+        error: (0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Invoice action REST API call errored out ' +
+            JSON.stringify(error)),
+        invoiceId,
+    }))));
+}));
+exports.runInvoicingInvoiceActionEpic = runInvoicingInvoiceActionEpic;
+const updateInvoicingInvoiceEpic = (actions$, _state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(invoiceActionReducer_1.updateInvoicingInvoice.match), (0, operators_1.mergeMap)((action) => {
+    const { data, invoiceId } = action.payload;
+    const apiUrl = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0/invoices/${encodeURIComponent(invoiceId)}`;
+    return zeniAPI
+        .putAndGetJSON(apiUrl, data)
+        .pipe((0, operators_1.mergeMap)((response) => {
+        if ((0, responsePayload_1.isSuccessResponse)(response) && response.data != null) {
+            return [
+                (0, invoiceReducer_1.updateInvoices)([response.data], 'merge'),
+                (0, invoiceActionReducer_1.runInvoicingInvoiceActionSuccess)({ invoiceId }),
+            ];
+        }
+        return (0, rxjs_1.of)((0, invoiceActionReducer_1.runInvoicingInvoiceActionFailure)({
+            error: response.status,
+            invoiceId,
+        }));
+    }), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, invoiceActionReducer_1.runInvoicingInvoiceActionFailure)({
+        error: (0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Invoice update REST API call errored out ' +
+            JSON.stringify(error)),
+        invoiceId,
+    }))));
+}));
+exports.updateInvoicingInvoiceEpic = updateInvoicingInvoiceEpic;

package/lib/view/invoicing/invoiceAction/invoiceActionPayload.d.ts

@@ -0,0 +1,3 @@
+import { InvoicingInvoicePayload } from '../../../entity/invoicing/invoice/invoicePayload';
+import { ZeniAPIResponse } from '../../../responsePayload';
+export type InvoicingInvoiceActionResponse = ZeniAPIResponse<InvoicingInvoicePayload>;

package/lib/view/invoicing/invoiceAction/invoiceActionPayload.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/view/invoicing/invoiceAction/invoiceActionReducer.d.ts

@@ -0,0 +1,24 @@
+import { ID } from '../../../commonStateTypes/common';
+import { ZeniAPIStatus } from '../../../responsePayload';
+import { InvoicingInvoiceActionBody } from './invoiceActionRequestPayload';
+import { InvoicingInvoiceActionState } from './invoiceActionState';
+export type InvoicingInvoiceActionKind = 'apply-excess' | 'collect' | 'issue-credit-note' | 'record-payment' | 'refund-excess' | 'regenerate' | 'remove-payment' | 'payment-schedule' | 'send' | 'send-reminder' | 'void' | 'write-off';
+export interface RunInvoicingInvoiceActionPayload {
+    action: InvoicingInvoiceActionKind;
+    invoiceId: ID;
+    /** Optional JSON body for actions that take parameters (e.g. record-payment). */
+    body?: InvoicingInvoiceActionBody;
+}
+export interface UpdateInvoicingInvoicePayload {
+    data: Record<string, unknown>;
+    invoiceId: ID;
+}
+export declare const initialState: InvoicingInvoiceActionState;
+export declare const runInvoicingInvoiceAction: import("@reduxjs/toolkit").ActionCreatorWithPayload<RunInvoicingInvoiceActionPayload, "invoicingInvoiceAction/runInvoicingInvoiceAction">, runInvoicingInvoiceActionSuccess: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    invoiceId: ID;
+}, "invoicingInvoiceAction/runInvoicingInvoiceActionSuccess">, runInvoicingInvoiceActionFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    error: ZeniAPIStatus;
+    invoiceId: ID;
+}, "invoicingInvoiceAction/runInvoicingInvoiceActionFailure">, updateInvoicingInvoice: import("@reduxjs/toolkit").ActionCreatorWithPayload<UpdateInvoicingInvoicePayload, "invoicingInvoiceAction/updateInvoicingInvoice">, clearInvoicingInvoiceAction: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "invoicingInvoiceAction/clearInvoicingInvoiceAction">, clearAllInvoicingInvoiceActions: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingInvoiceAction/clearAllInvoicingInvoiceActions">;
+declare const _default: import("redux").Reducer<InvoicingInvoiceActionState>;
+export default _default;