@zeniai/client-epic-state 5.1.60-betaDI1 → 5.1.61-betaDI0

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,17 @@
+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 (looked up in the shared address store by `shippingAddressId`, same as
+ * the customer billing-address flow).
+ * 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,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initializeInvoicingSubscriptionAddressEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const addressSelector_1 = require("../../../entity/address/addressSelector");
+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 (looked up in the shared address store by `shippingAddressId`, same as
+ * the customer billing-address flow).
+ * 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);
+    const address = subscription?.shippingAddressId != null
+        ? (0, addressSelector_1.getAddressByAddressId)(rootState.addressState, subscription.shippingAddressId)
+        : undefined;
+    return address != null
+        ? (0, rxjs_1.of)((0, addressViewReducer_1.newAddressInLocalStore)({
+            addressType: invoicingSubscriptionFormConfig_1.INVOICING_SUBSCRIPTION_SHIPPING_ADDRESS_TYPE,
+            addressToCreate: address,
+        }))
+        : rxjs_1.EMPTY;
+}));
+exports.initializeInvoicingSubscriptionAddressEpic = initializeInvoicingSubscriptionAddressEpic;

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

@@ -0,0 +1,20 @@
+import { InvoicingSubscription } from '../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionState';
+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;

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

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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 subscriptionItemPriceCodes = (subscription, itemType) => subscription?.subscriptionItems
+    ?.filter((item) => item.itemType === itemType)
+    .map((item) => item.itemPriceCode)
+    .filter((code) => code != null && code !== '') ?? [];
+exports.initialInvoicingSubscriptionFormLocalData = {
+    addonPriceCodes: [],
+    autoCollection: true,
+    billingFrequency: 'monthly',
+    chargePriceCodes: [],
+    couponId: '',
+    customerId: '',
+    planPriceCode: '',
+    planQuantity: 1,
+    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 };
+    }
+    const planItem = subscription.subscriptionItems?.find((item) => item.itemType === 'plan');
+    return {
+        addonPriceCodes: subscriptionItemPriceCodes(subscription, 'addon'),
+        autoCollection: (subscription.autoCollection ?? 'on') === 'on',
+        billingFrequency: (0, exports.periodToBillingFrequency)(subscription.billingPeriod, subscription.billingPeriodUnit),
+        chargePriceCodes: subscriptionItemPriceCodes(subscription, 'charge'),
+        couponId: subscription.coupons?.[0]?.couponCode ??
+            subscription.coupons?.[0]?.couponID ??
+            '',
+        customerId: subscription.customerID ?? '',
+        planPriceCode: subscriptionItemPriceCodes(subscription, 'plan')[0] ?? '',
+        planQuantity: planItem?.quantity ?? 1,
+        poNumber: subscription.poNumber ?? '',
+        preferredCurrencyCode: subscription.currencyCode ?? 'USD',
+        setupFee: '',
+        trialEnd: subscription.trialEnd != null
+            ? subscription.trialEnd.format('YYYY-MM-DD')
+            : '',
+    };
+};
+exports.entityToInvoicingSubscriptionFormLocalData = entityToInvoicingSubscriptionFormLocalData;

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

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

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

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.saveInvoicingSubscriptionEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const addressReducer_1 = require("../../../entity/address/addressReducer");
+const invoicingSubscriptionPayload_1 = require("../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionPayload");
+const invoicingSubscriptionReducer_1 = require("../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionReducer");
+const responsePayload_1 = require("../../../responsePayload");
+const addressViewReducer_1 = require("../../addressView/addressViewReducer");
+const invoicingSubscriptionListViewReducer_1 = require("../invoicingSubscriptionListView/invoicingSubscriptionListViewReducer");
+const editInvoicingSubscriptionDetailViewPayload_1 = require("./editInvoicingSubscriptionDetailViewPayload");
+const editInvoicingSubscriptionDetailViewReducer_1 = require("./editInvoicingSubscriptionDetailViewReducer");
+const invoicingSubscriptionFormConfig_1 = require("./invoicingSubscriptionFormConfig");
+const normalizeCouponCode = (value) => (value ?? '').trim().toUpperCase();
+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);
+    // Coupons are synced via apply/remove-coupon after PUT (not via coupon_ids).
+    if (id != null) {
+        delete data.coupon_ids;
+    }
+    const baseUrl = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0`;
+    const previousCouponCode = id != null
+        ? (rootState.invoicingSubscriptionState.invoicingSubscriptionByID[id]
+            ?.coupons?.[0]?.couponCode ??
+            rootState.invoicingSubscriptionState.invoicingSubscriptionByID[id]
+                ?.coupons?.[0]?.couponID ??
+            '')
+        : '';
+    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, editInvoicingSubscriptionDetailViewReducer_1.submitInvoicingSubscriptionFormFailure)(response.status)];
+        }
+        const saved = response.data;
+        const couponChanged = id != null &&
+            normalizeCouponCode(previousCouponCode) !==
+                normalizeCouponCode(localData.couponId);
+        // Edit + coupon change: merge the saved subscription, then hand the
+        // coupon attach/detach to syncInvoicingSubscriptionCouponsEpic, which
+        // finishes the flow (form success on both calls ok, form failure
+        // otherwise). Deferring success here is deliberate — a swallowed
+        // coupon failure must no longer surface as a false save success.
+        if (couponChanged) {
+            return [
+                (0, invoicingSubscriptionReducer_1.updateInvoicingSubscriptions)([saved], 'merge'),
+                (0, addressReducer_1.updateAddresses)((0, invoicingSubscriptionPayload_1.extractInvoicingSubscriptionAddresses)([saved])),
+                (0, editInvoicingSubscriptionDetailViewReducer_1.syncInvoicingSubscriptionCoupons)({
+                    subscriptionId: saved.id,
+                    previousCouponCode,
+                    nextCouponCode: localData.couponId,
+                }),
+            ];
+        }
+        const resultActions = [
+            (0, invoicingSubscriptionReducer_1.updateInvoicingSubscriptions)([saved], 'merge'),
+            (0, addressReducer_1.updateAddresses)((0, invoicingSubscriptionPayload_1.extractInvoicingSubscriptionAddresses)([saved])),
+            (0, editInvoicingSubscriptionDetailViewReducer_1.submitInvoicingSubscriptionFormSuccess)({
+                subscriptionId: saved.id,
+            }),
+            // Clear the stashed address so the next subscription starts fresh.
+            (0, addressViewReducer_1.resetNewAddressDataInLocalStore)(invoicingSubscriptionFormConfig_1.INVOICING_SUBSCRIPTION_SHIPPING_ADDRESS_TYPE),
+        ];
+        // Create (no id): reflect the new row + tab counts in the cached list
+        // so the list page shows it without a refetch. Edits keep the same
+        // id/counts, so the entity merge above is enough.
+        if (id == null) {
+            resultActions.push((0, invoicingSubscriptionListViewReducer_1.addInvoicingSubscriptionToList)({
+                id: saved.id,
+                status: saved.status,
+            }));
+        }
+        return resultActions;
+    }), (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/editInvoicingSubscriptionDetailView/syncInvoicingSubscriptionCouponsEpic.d.ts

@@ -0,0 +1,17 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { updateAddresses } from '../../../entity/address/addressReducer';
+import { updateInvoicingSubscriptions } from '../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionReducer';
+import { RootState } from '../../../reducer';
+import { ZeniAPI } from '../../../zeniAPI';
+import { resetNewAddressDataInLocalStore } from '../../addressView/addressViewReducer';
+import { submitInvoicingSubscriptionFormFailure, submitInvoicingSubscriptionFormSuccess, syncInvoicingSubscriptionCoupons } from './editInvoicingSubscriptionDetailViewReducer';
+export type ActionType = ReturnType<typeof syncInvoicingSubscriptionCoupons> | ReturnType<typeof submitInvoicingSubscriptionFormSuccess> | ReturnType<typeof submitInvoicingSubscriptionFormFailure> | ReturnType<typeof resetNewAddressDataInLocalStore> | ReturnType<typeof updateAddresses> | ReturnType<typeof updateInvoicingSubscriptions>;
+/**
+ * After a commercial PUT, sync coupon attach/detach via dedicated endpoints
+ * (PUT does not replace coupons). Runs remove-then-apply; on success finishes
+ * the save flow (entity merge + address reset + form success), on failure
+ * dispatches the form failure so the swallowed-error false success no longer
+ * happens.
+ */
+export declare const syncInvoicingSubscriptionCouponsEpic: (actions$: ActionsObservable<ActionType>, _state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;

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

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.syncInvoicingSubscriptionCouponsEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const addressReducer_1 = require("../../../entity/address/addressReducer");
+const invoicingSubscriptionPayload_1 = require("../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionPayload");
+const invoicingSubscriptionReducer_1 = require("../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionReducer");
+const responsePayload_1 = require("../../../responsePayload");
+const addressViewReducer_1 = require("../../addressView/addressViewReducer");
+const editInvoicingSubscriptionDetailViewReducer_1 = require("./editInvoicingSubscriptionDetailViewReducer");
+const invoicingSubscriptionFormConfig_1 = require("./invoicingSubscriptionFormConfig");
+const normalizeCouponCode = (value) => (value ?? '').trim().toUpperCase();
+const couponMutation$ = (zeniAPI, baseUrl, subscriptionId, endpoint, couponCode) => zeniAPI
+    .postAndGetJSON(`${baseUrl}/subscriptions/${encodeURIComponent(subscriptionId)}/${endpoint}`, { coupon_code: couponCode })
+    .pipe((0, operators_1.map)((response) => (0, responsePayload_1.isSuccessResponse)(response)
+    ? { success: true, payload: response.data ?? null }
+    : { success: false, payload: null, status: response.status }), (0, operators_1.catchError)((error) => (0, rxjs_1.of)({
+    success: false,
+    payload: null,
+    status: (0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', `${endpoint} REST API call errored out ` + JSON.stringify(error)),
+})));
+const failureStatus = (step) => step.status ??
+    (0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Coupon sync failed without a status');
+/**
+ * After a commercial PUT, sync coupon attach/detach via dedicated endpoints
+ * (PUT does not replace coupons). Runs remove-then-apply; on success finishes
+ * the save flow (entity merge + address reset + form success), on failure
+ * dispatches the form failure so the swallowed-error false success no longer
+ * happens.
+ */
+const syncInvoicingSubscriptionCouponsEpic = (actions$, _state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(editInvoicingSubscriptionDetailViewReducer_1.syncInvoicingSubscriptionCoupons.match), (0, operators_1.mergeMap)((action) => {
+    const { subscriptionId, previousCouponCode, nextCouponCode } = action.payload;
+    const prev = normalizeCouponCode(previousCouponCode);
+    const next = normalizeCouponCode(nextCouponCode);
+    if (prev === next) {
+        return rxjs_1.EMPTY;
+    }
+    const baseUrl = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0`;
+    const removeStep$ = prev === ''
+        ? (0, rxjs_1.of)({ success: true, payload: null })
+        : couponMutation$(zeniAPI, baseUrl, subscriptionId, 'remove-coupon', prev);
+    return removeStep$.pipe((0, operators_1.mergeMap)((removeResult) => {
+        if (!removeResult.success) {
+            return (0, rxjs_1.of)((0, editInvoicingSubscriptionDetailViewReducer_1.submitInvoicingSubscriptionFormFailure)(failureStatus(removeResult)));
+        }
+        const applyStep$ = next === ''
+            ? (0, rxjs_1.of)({
+                success: true,
+                payload: removeResult.payload,
+            })
+            : couponMutation$(zeniAPI, baseUrl, subscriptionId, 'apply-coupon', next);
+        return applyStep$.pipe((0, operators_1.mergeMap)((applyResult) => {
+            if (!applyResult.success) {
+                return [
+                    (0, editInvoicingSubscriptionDetailViewReducer_1.submitInvoicingSubscriptionFormFailure)(failureStatus(applyResult)),
+                ];
+            }
+            const couponUpdated = applyResult.payload ?? removeResult.payload;
+            const resultActions = [];
+            if (couponUpdated != null) {
+                resultActions.push((0, invoicingSubscriptionReducer_1.updateInvoicingSubscriptions)([couponUpdated], 'merge'), (0, addressReducer_1.updateAddresses)((0, invoicingSubscriptionPayload_1.extractInvoicingSubscriptionAddresses)([couponUpdated])));
+            }
+            resultActions.push((0, editInvoicingSubscriptionDetailViewReducer_1.submitInvoicingSubscriptionFormSuccess)({ subscriptionId }), (0, addressViewReducer_1.resetNewAddressDataInLocalStore)(invoicingSubscriptionFormConfig_1.INVOICING_SUBSCRIPTION_SHIPPING_ADDRESS_TYPE));
+            return resultActions;
+        }));
+    }));
+}));
+exports.syncInvoicingSubscriptionCouponsEpic = syncInvoicingSubscriptionCouponsEpic;

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

@@ -0,0 +1,10 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { updateAddresses } from '../../../entity/address/addressReducer';
+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 updateAddresses> | 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,59 @@
+"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 addressReducer_1 = require("../../../entity/address/addressReducer");
+const invoicePayload_1 = require("../../../entity/invoicing/invoice/invoicePayload");
+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)((action) => invoiceActionReducer_1.runInvoicingInvoiceAction.match(action) &&
+    action.payload.action !== 'issue-credit-note'), (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, addressReducer_1.updateAddresses)((0, invoicePayload_1.extractInvoicingInvoiceAddresses)([response.data])),
+                (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, addressReducer_1.updateAddresses)((0, invoicePayload_1.extractInvoicingInvoiceAddresses)([response.data])),
+                (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;

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

@@ -0,0 +1,46 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearAllInvoicingInvoiceActions = exports.clearInvoicingInvoiceAction = exports.updateInvoicingInvoice = exports.runInvoicingInvoiceActionFailure = exports.runInvoicingInvoiceActionSuccess = exports.runInvoicingInvoiceAction = exports.initialState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+exports.initialState = {
+    byInvoiceId: {},
+};
+const invoiceAction = (0, toolkit_1.createSlice)({
+    name: 'invoicingInvoiceAction',
+    initialState: exports.initialState,
+    reducers: {
+        runInvoicingInvoiceAction(draft, action) {
+            draft.byInvoiceId[action.payload.invoiceId] = {
+                fetchState: 'In-Progress',
+                error: undefined,
+            };
+        },
+        runInvoicingInvoiceActionSuccess(draft, action) {
+            draft.byInvoiceId[action.payload.invoiceId] = {
+                fetchState: 'Completed',
+                error: undefined,
+            };
+        },
+        runInvoicingInvoiceActionFailure(draft, action) {
+            draft.byInvoiceId[action.payload.invoiceId] = {
+                fetchState: 'Error',
+                error: action.payload.error,
+            };
+        },
+        updateInvoicingInvoice(draft, action) {
+            draft.byInvoiceId[action.payload.invoiceId] = {
+                fetchState: 'In-Progress',
+                error: undefined,
+            };
+        },
+        clearInvoicingInvoiceAction(draft, action) {
+            delete draft.byInvoiceId[action.payload];
+        },
+        clearAllInvoicingInvoiceActions(draft) {
+            draft.byInvoiceId = {};
+        },
+    },
+});
+_a = invoiceAction.actions, exports.runInvoicingInvoiceAction = _a.runInvoicingInvoiceAction, exports.runInvoicingInvoiceActionSuccess = _a.runInvoicingInvoiceActionSuccess, exports.runInvoicingInvoiceActionFailure = _a.runInvoicingInvoiceActionFailure, exports.updateInvoicingInvoice = _a.updateInvoicingInvoice, exports.clearInvoicingInvoiceAction = _a.clearInvoicingInvoiceAction, exports.clearAllInvoicingInvoiceActions = _a.clearAllInvoicingInvoiceActions;
+exports.default = invoiceAction.reducer;

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

@@ -0,0 +1,52 @@
+/** Snake_case request bodies for invoice action endpoints. */
+export type RecordPaymentBody = {
+    amount: number;
+    date?: string;
+    gateway?: string;
+    installment_id?: string;
+    payment_method?: string;
+    reference_number?: string;
+};
+export type WriteOffBody = {
+    amount: number;
+    reason?: string;
+};
+export type IssueCreditNoteLineItemBody = {
+    amount?: number;
+    description?: string;
+    entity_type?: string;
+    id?: string;
+    quantity?: number;
+    unit_amount?: number;
+};
+export type IssueCreditNoteBody = {
+    amount?: number;
+    line_items?: IssueCreditNoteLineItemBody[];
+    reason_code?: string;
+    type?: 'adjustment' | 'refundable' | 'store';
+};
+export type RemovePaymentBody = {
+    txn_id: string;
+};
+export type ApplyExcessBody = {
+    amount: number;
+    target_invoice_id: string;
+};
+export type PaymentInstallmentBody = {
+    amount: number;
+    due_date: string;
+    id?: string;
+    seq?: number;
+};
+export type PaymentScheduleBody = {
+    installments: PaymentInstallmentBody[];
+    interval_count?: number;
+    interval_unit?: 'month' | 'year' | 'week' | 'day';
+    type?: 'fixed' | 'flexible';
+};
+export type VoidInvoiceBody = {
+    create_adjustment_credit_note?: boolean;
+    credit_note_date?: string;
+    reason_code?: string;
+};
+export type InvoicingInvoiceActionBody = RecordPaymentBody | WriteOffBody | IssueCreditNoteBody | RemovePaymentBody | ApplyExcessBody | PaymentScheduleBody | VoidInvoiceBody | Record<string, never>;

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

@@ -0,0 +1,3 @@
+"use strict";
+/** Snake_case request bodies for invoice action endpoints. */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,3 @@
+import { FetchStateAndError, ID } from '../../../commonStateTypes/common';
+import { RootState } from '../../../reducer';
+export declare const getInvoicingInvoiceActionState: (invoiceId: ID) => (state: RootState) => FetchStateAndError;