@zeniai/client-epic-state 5.1.60 → 5.1.61

package/lib/view/invoicing/paymentAction/paymentActionPayload.d.ts

@@ -0,0 +1,3 @@
+import { InvoicingTransactionPayload } from '../../../entity/invoicing/invoicingTransaction/invoicingTransactionPayload';
+import { ZeniAPIResponse } from '../../../responsePayload';
+export type InvoicingPaymentActionResponse = ZeniAPIResponse<InvoicingTransactionPayload>;

package/lib/view/invoicing/paymentAction/paymentActionPayload.js

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

package/lib/view/invoicing/paymentAction/paymentActionReducer.d.ts

@@ -0,0 +1,19 @@
+import { ID } from '../../../commonStateTypes/common';
+import { ZeniAPIStatus } from '../../../responsePayload';
+import { InvoicingPaymentActionBody } from './paymentActionRequestPayload';
+import { InvoicingPaymentActionState } from './paymentActionState';
+export interface RunInvoicingPaymentActionPayload {
+    action: string;
+    id: ID;
+    /** Optional JSON body for actions that take parameters. */
+    body?: InvoicingPaymentActionBody;
+}
+export declare const initialState: InvoicingPaymentActionState;
+export declare const runInvoicingPaymentAction: import("@reduxjs/toolkit").ActionCreatorWithPayload<RunInvoicingPaymentActionPayload, "invoicingPaymentAction/runInvoicingPaymentAction">, runInvoicingPaymentActionSuccess: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    id: ID;
+}, "invoicingPaymentAction/runInvoicingPaymentActionSuccess">, runInvoicingPaymentActionFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    error: ZeniAPIStatus;
+    id: ID;
+}, "invoicingPaymentAction/runInvoicingPaymentActionFailure">, clearInvoicingPaymentAction: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "invoicingPaymentAction/clearInvoicingPaymentAction">, clearAllInvoicingPaymentActions: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingPaymentAction/clearAllInvoicingPaymentActions">;
+declare const _default: import("redux").Reducer<InvoicingPaymentActionState>;
+export default _default;

package/lib/view/invoicing/paymentAction/paymentActionReducer.js

@@ -0,0 +1,40 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearAllInvoicingPaymentActions = exports.clearInvoicingPaymentAction = exports.runInvoicingPaymentActionFailure = exports.runInvoicingPaymentActionSuccess = exports.runInvoicingPaymentAction = exports.initialState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+exports.initialState = {
+    byId: {},
+};
+const paymentAction = (0, toolkit_1.createSlice)({
+    name: 'invoicingPaymentAction',
+    initialState: exports.initialState,
+    reducers: {
+        runInvoicingPaymentAction(draft, action) {
+            draft.byId[action.payload.id] = {
+                fetchState: 'In-Progress',
+                error: undefined,
+            };
+        },
+        runInvoicingPaymentActionSuccess(draft, action) {
+            draft.byId[action.payload.id] = {
+                fetchState: 'Completed',
+                error: undefined,
+            };
+        },
+        runInvoicingPaymentActionFailure(draft, action) {
+            draft.byId[action.payload.id] = {
+                fetchState: 'Error',
+                error: action.payload.error,
+            };
+        },
+        clearInvoicingPaymentAction(draft, action) {
+            delete draft.byId[action.payload];
+        },
+        clearAllInvoicingPaymentActions(draft) {
+            draft.byId = {};
+        },
+    },
+});
+_a = paymentAction.actions, exports.runInvoicingPaymentAction = _a.runInvoicingPaymentAction, exports.runInvoicingPaymentActionSuccess = _a.runInvoicingPaymentActionSuccess, exports.runInvoicingPaymentActionFailure = _a.runInvoicingPaymentActionFailure, exports.clearInvoicingPaymentAction = _a.clearInvoicingPaymentAction, exports.clearAllInvoicingPaymentActions = _a.clearAllInvoicingPaymentActions;
+exports.default = paymentAction.reducer;

package/lib/view/invoicing/paymentAction/paymentActionRequestPayload.d.ts

@@ -0,0 +1,7 @@
+/** Snake_case request bodies for payment action endpoints. */
+export type RefundPaymentBody = {
+    amount?: number;
+    reason?: string;
+    refund_method?: string;
+};
+export type InvoicingPaymentActionBody = RefundPaymentBody | Record<string, never>;

package/lib/view/invoicing/paymentAction/paymentActionRequestPayload.js

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

package/lib/view/invoicing/paymentAction/paymentActionSelector.d.ts

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

package/lib/view/invoicing/paymentAction/paymentActionSelector.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInvoicingPaymentActionState = void 0;
+const NOT_STARTED = {
+    fetchState: 'Not-Started',
+    error: undefined,
+};
+const getInvoicingPaymentActionState = (id) => (state) => state.invoicingPaymentActionState.byId[id] ?? NOT_STARTED;
+exports.getInvoicingPaymentActionState = getInvoicingPaymentActionState;

package/lib/view/invoicing/paymentAction/paymentActionState.d.ts

@@ -0,0 +1,5 @@
+import { FetchStateAndError, ID } from '../../../commonStateTypes/common';
+/** Per-payment action fetch state keyed by payment id. */
+export interface InvoicingPaymentActionState {
+    byId: Record<ID, FetchStateAndError>;
+}

package/lib/view/invoicing/paymentAction/paymentActionState.js

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

package/lib/view/invoicing/promotionalCreditAction/promotionalCreditActionEpic.d.ts

@@ -0,0 +1,8 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { RootState } from '../../../reducer';
+import { ZeniAPI } from '../../../zeniAPI';
+import { fetchInvoicingCustomerDetail } from '../invoicingCustomerDetailView/invoicingCustomerDetailViewReducer';
+import { addPromotionalCreditsFailure, addPromotionalCreditsSuccess, submitAddPromotionalCredits } from './promotionalCreditActionReducer';
+export type ActionType = ReturnType<typeof submitAddPromotionalCredits> | ReturnType<typeof addPromotionalCreditsSuccess> | ReturnType<typeof addPromotionalCreditsFailure> | ReturnType<typeof fetchInvoicingCustomerDetail>;
+export declare const addPromotionalCreditsEpic: (actions$: ActionsObservable<ActionType>, _state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;

package/lib/view/invoicing/promotionalCreditAction/promotionalCreditActionEpic.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addPromotionalCreditsEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const responsePayload_1 = require("../../../responsePayload");
+const invoicingCustomerDetailViewReducer_1 = require("../invoicingCustomerDetailView/invoicingCustomerDetailViewReducer");
+const promotionalCreditActionReducer_1 = require("./promotionalCreditActionReducer");
+const addPromotionalCreditsEpic = (actions$, _state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(promotionalCreditActionReducer_1.submitAddPromotionalCredits.match), (0, operators_1.mergeMap)((action) => {
+    const { amount, currencyCode, customerId, description } = action.payload;
+    const apiUrl = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0/customers/${encodeURIComponent(customerId)}/promotional-credits`;
+    const body = { amount, description };
+    if (currencyCode != null && currencyCode !== '') {
+        body.currency_code = currencyCode;
+    }
+    return zeniAPI
+        .postAndGetJSON(apiUrl, body)
+        .pipe((0, operators_1.mergeMap)((response) => {
+        if ((0, responsePayload_1.isSuccessResponse)(response) && response.data != null) {
+            return [
+                (0, promotionalCreditActionReducer_1.addPromotionalCreditsSuccess)(),
+                (0, invoicingCustomerDetailViewReducer_1.fetchInvoicingCustomerDetail)({ id: customerId }),
+            ];
+        }
+        return (0, rxjs_1.of)((0, promotionalCreditActionReducer_1.addPromotionalCreditsFailure)(response.status));
+    }), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, promotionalCreditActionReducer_1.addPromotionalCreditsFailure)((0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Add promotional credits REST API call errored out ' +
+        JSON.stringify(error))))));
+}));
+exports.addPromotionalCreditsEpic = addPromotionalCreditsEpic;

package/lib/view/invoicing/promotionalCreditAction/promotionalCreditActionPayload.d.ts

@@ -0,0 +1,3 @@
+import { InvoicingCustomerPayload } from '../../../entity/invoicing/invoicingCustomer/invoicingCustomerPayload';
+import { ZeniAPIResponse } from '../../../responsePayload';
+export type AddPromotionalCreditsResponse = ZeniAPIResponse<InvoicingCustomerPayload>;

package/lib/view/invoicing/promotionalCreditAction/promotionalCreditActionPayload.js

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

package/lib/view/invoicing/promotionalCreditAction/promotionalCreditActionReducer.d.ts

@@ -0,0 +1,13 @@
+import { ID } from '../../../commonStateTypes/common';
+import { ZeniAPIStatus } from '../../../responsePayload';
+import { PromotionalCreditActionState } from './promotionalCreditActionState';
+export interface SubmitAddPromotionalCreditsPayload {
+    amount: number;
+    customerId: ID;
+    description: string;
+    currencyCode?: string;
+}
+export declare const initialState: PromotionalCreditActionState;
+export declare const submitAddPromotionalCredits: import("@reduxjs/toolkit").ActionCreatorWithPayload<SubmitAddPromotionalCreditsPayload, "invoicingPromotionalCreditAction/submitAddPromotionalCredits">, addPromotionalCreditsSuccess: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingPromotionalCreditAction/addPromotionalCreditsSuccess">, addPromotionalCreditsFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<ZeniAPIStatus<Record<string, unknown>>, "invoicingPromotionalCreditAction/addPromotionalCreditsFailure">, resetPromotionalCreditAction: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingPromotionalCreditAction/resetPromotionalCreditAction">;
+declare const _default: import("redux").Reducer<PromotionalCreditActionState>;
+export default _default;

package/lib/view/invoicing/promotionalCreditAction/promotionalCreditActionReducer.js

@@ -0,0 +1,35 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resetPromotionalCreditAction = exports.addPromotionalCreditsFailure = exports.addPromotionalCreditsSuccess = exports.submitAddPromotionalCredits = exports.initialState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+exports.initialState = {
+    fetchState: 'Not-Started',
+    error: undefined,
+    customerId: undefined,
+    submitFetchState: { fetchState: 'Not-Started', error: undefined },
+    hasValidState() {
+        return true;
+    },
+};
+const promotionalCreditAction = (0, toolkit_1.createSlice)({
+    name: 'invoicingPromotionalCreditAction',
+    initialState: exports.initialState,
+    reducers: {
+        submitAddPromotionalCredits(draft, action) {
+            draft.customerId = action.payload.customerId;
+            draft.submitFetchState = { fetchState: 'In-Progress', error: undefined };
+        },
+        addPromotionalCreditsSuccess(draft) {
+            draft.submitFetchState = { fetchState: 'Completed', error: undefined };
+        },
+        addPromotionalCreditsFailure(draft, action) {
+            draft.submitFetchState = { fetchState: 'Error', error: action.payload };
+        },
+        resetPromotionalCreditAction(draft) {
+            Object.assign(draft, exports.initialState);
+        },
+    },
+});
+_a = promotionalCreditAction.actions, exports.submitAddPromotionalCredits = _a.submitAddPromotionalCredits, exports.addPromotionalCreditsSuccess = _a.addPromotionalCreditsSuccess, exports.addPromotionalCreditsFailure = _a.addPromotionalCreditsFailure, exports.resetPromotionalCreditAction = _a.resetPromotionalCreditAction;
+exports.default = promotionalCreditAction.reducer;

package/lib/view/invoicing/promotionalCreditAction/promotionalCreditActionState.d.ts

@@ -0,0 +1,5 @@
+import { FetchStateAndError, FetchedState, ID } from '../../../commonStateTypes/common';
+export interface PromotionalCreditActionState extends FetchedState {
+    submitFetchState: FetchStateAndError;
+    customerId?: ID;
+}

package/lib/view/invoicing/promotionalCreditAction/promotionalCreditActionState.js

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

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

@@ -0,0 +1,11 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { updateInvoices } from '../../../entity/invoicing/invoice/invoiceReducer';
+import { updateInvoicingTransactions } from '../../../entity/invoicing/invoicingTransaction/invoicingTransactionReducer';
+import { RootState } from '../../../reducer';
+import { ZeniAPI } from '../../../zeniAPI';
+import { fetchInvoiceDetail } from '../invoiceDetail/invoiceDetailReducer';
+import { addInvoicingTransactionToList } from '../invoicingTransactionListView/invoicingTransactionListViewReducer';
+import { recordPaymentFailure, recordPaymentSuccess, submitRecordPayment } from './recordPaymentReducer';
+export type ActionType = ReturnType<typeof submitRecordPayment> | ReturnType<typeof recordPaymentSuccess> | ReturnType<typeof recordPaymentFailure> | ReturnType<typeof updateInvoicingTransactions> | ReturnType<typeof addInvoicingTransactionToList> | ReturnType<typeof updateInvoices> | ReturnType<typeof fetchInvoiceDetail>;
+export declare const recordPaymentEpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;

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

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.recordPaymentEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const invoiceReducer_1 = require("../../../entity/invoicing/invoice/invoiceReducer");
+const invoicingTransactionReducer_1 = require("../../../entity/invoicing/invoicingTransaction/invoicingTransactionReducer");
+const responsePayload_1 = require("../../../responsePayload");
+const invoiceDetailReducer_1 = require("../invoiceDetail/invoiceDetailReducer");
+const invoicingTransactionListViewReducer_1 = require("../invoicingTransactionListView/invoicingTransactionListViewReducer");
+const recordPaymentPayload_1 = require("./recordPaymentPayload");
+const recordPaymentReducer_1 = require("./recordPaymentReducer");
+const trimOrUndefined = (value) => value.trim() !== '' ? value.trim() : undefined;
+const linkedInvoiceIdFromDraft = (state) => {
+    const linkedInvoice = trimOrUndefined(state.invoicingRecordPaymentState.newPaymentDraft.invoiceToLink);
+    return linkedInvoice;
+};
+const recordPaymentEpic = (actions$, state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(recordPaymentReducer_1.submitRecordPayment.match), (0, operators_1.mergeMap)((action) => {
+    const draft = state$.value.invoicingRecordPaymentState.newPaymentDraft;
+    const invoiceId = action.payload.invoiceId;
+    if (invoiceId != null && invoiceId !== '') {
+        const apiUrl = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0/invoices/${encodeURIComponent(invoiceId)}/record-payment`;
+        const body = (0, recordPaymentPayload_1.localDataToInvoiceRecordPaymentBody)(draft);
+        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, invoiceDetailReducer_1.fetchInvoiceDetail)({ invoiceId }),
+                    (0, recordPaymentReducer_1.recordPaymentSuccess)({ invoiceId }),
+                ];
+            }
+            return (0, rxjs_1.of)((0, recordPaymentReducer_1.recordPaymentFailure)(response.status));
+        }), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, recordPaymentReducer_1.recordPaymentFailure)((0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Record payment REST API call errored out ' +
+            JSON.stringify(error))))));
+    }
+    const apiUrl = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0/payments`;
+    const data = (0, recordPaymentPayload_1.localDataToRecordPaymentPayload)(draft);
+    const linkedInvoiceId = linkedInvoiceIdFromDraft(state$.value);
+    return zeniAPI
+        .postAndGetJSON(apiUrl, {
+        ...data,
+    })
+        .pipe((0, operators_1.mergeMap)((response) => {
+        if ((0, responsePayload_1.isSuccessResponse)(response) && response.data != null) {
+            const successActions = [
+                (0, invoicingTransactionReducer_1.updateInvoicingTransactions)([response.data], 'merge'),
+                (0, invoicingTransactionListViewReducer_1.addInvoicingTransactionToList)(response.data.id),
+                (0, recordPaymentReducer_1.recordPaymentSuccess)({ transactionId: response.data.id }),
+            ];
+            if (linkedInvoiceId != null) {
+                successActions.push((0, invoiceDetailReducer_1.fetchInvoiceDetail)({ invoiceId: linkedInvoiceId }));
+            }
+            return successActions;
+        }
+        return (0, rxjs_1.of)((0, recordPaymentReducer_1.recordPaymentFailure)(response.status));
+    }), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, recordPaymentReducer_1.recordPaymentFailure)((0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Record payment REST API call errored out ' +
+        JSON.stringify(error))))));
+}));
+exports.recordPaymentEpic = recordPaymentEpic;

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

@@ -0,0 +1,8 @@
+import { RecordPaymentFormLocalData } from './recordPaymentState';
+/**
+ * Canonical value sets for the Record Payment form. CES owns the values;
+ * web-components maps each value to a localized label.
+ */
+export declare const INVOICING_PAYMENT_METHOD_VALUES: readonly ["card", "cash", "check", "bank_transfer", "direct_debit", "paypal_express_checkout", "apple_pay", "google_pay", "ach_credit", "sepa_credit", "other"];
+export declare const INVOICING_PAYMENT_GATEWAY_VALUES: readonly ["stripe", "chargebee", "braintree", "paypal", "adyen", "razorpay", "other"];
+export declare const initialRecordPaymentFormLocalData: RecordPaymentFormLocalData;

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

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initialRecordPaymentFormLocalData = exports.INVOICING_PAYMENT_GATEWAY_VALUES = exports.INVOICING_PAYMENT_METHOD_VALUES = void 0;
+/**
+ * Canonical value sets for the Record Payment form. CES owns the values;
+ * web-components maps each value to a localized label.
+ */
+exports.INVOICING_PAYMENT_METHOD_VALUES = [
+    'card',
+    'cash',
+    'check',
+    'bank_transfer',
+    'direct_debit',
+    'paypal_express_checkout',
+    'apple_pay',
+    'google_pay',
+    'ach_credit',
+    'sepa_credit',
+    'other',
+];
+exports.INVOICING_PAYMENT_GATEWAY_VALUES = [
+    'stripe',
+    'chargebee',
+    'braintree',
+    'paypal',
+    'adyen',
+    'razorpay',
+    'other',
+];
+exports.initialRecordPaymentFormLocalData = {
+    amount: '',
+    comment: '',
+    customerId: '',
+    date: '',
+    gateway: '',
+    invoiceToLink: '',
+    paymentMethod: '',
+    referenceNumber: '',
+    transactionId: '',
+};

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

@@ -0,0 +1,47 @@
+import { InvoicingInvoicePayload } from '../../../entity/invoicing/invoice/invoicePayload';
+import { InvoicingInvoice } from '../../../entity/invoicing/invoice/invoiceState';
+import { InvoicingTransactionPayload } from '../../../entity/invoicing/invoicingTransaction/invoicingTransactionPayload';
+import { ZeniAPIResponse } from '../../../responsePayload';
+import { RecordPaymentFormLocalData } from './recordPaymentState';
+/** Invoice reference linked to a recorded payment (amounts in dollars). */
+export interface RecordPaymentLinkedInvoice {
+    applied_amount: number;
+    invoice_id: string;
+}
+/** Request body for recording a manual payment; mirrors the Invoicing backend. */
+export interface RecordPaymentRequest {
+    amount: number;
+    customer_id: string;
+    payment_method: string;
+    currency_code?: string;
+    date?: string;
+    gateway?: string;
+    id_at_gateway?: string;
+    linked_invoices?: RecordPaymentLinkedInvoice[];
+    notes?: string;
+    reference_number?: string;
+    status?: string;
+    type?: string;
+}
+/** Request body for POST /invoices/{id}/record-payment (amount in dollars). */
+export interface InvoiceRecordPaymentRequest {
+    amount: number;
+    payment_method: string;
+    date?: string;
+    gateway?: string;
+    reference_number?: string;
+}
+export type RecordPaymentResponse = ZeniAPIResponse<InvoicingTransactionPayload>;
+export type InvoiceRecordPaymentResponse = ZeniAPIResponse<InvoicingInvoicePayload>;
+/**
+ * Build the invoice-scoped Record Payment body from the form draft. Amount stays
+ * in dollars for the invoice endpoint.
+ */
+export declare const localDataToInvoiceRecordPaymentBody: (localData: RecordPaymentFormLocalData) => InvoiceRecordPaymentRequest;
+/**
+ * Build the Record Payment request body from the form draft. Amount stays in
+ * dollars; the comment maps to `notes`, transaction id to `id_at_gateway`,
+ * and the linked invoice into `linked_invoices`. Currency is locked to USD.
+ */
+export declare const localDataToRecordPaymentPayload: (localData: RecordPaymentFormLocalData) => RecordPaymentRequest;
+export declare const initializeRecordPaymentDraftFromInvoice: (invoice: InvoicingInvoice) => RecordPaymentFormLocalData;

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

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initializeRecordPaymentDraftFromInvoice = exports.localDataToRecordPaymentPayload = exports.localDataToInvoiceRecordPaymentBody = void 0;
+const zeniDayJS_1 = require("../../../zeniDayJS");
+const recordPaymentFormConfig_1 = require("./recordPaymentFormConfig");
+const trimOrUndefined = (value) => value.trim() !== '' ? value.trim() : undefined;
+const dollarsFromAmountString = (value) => {
+    const parsed = Number.parseFloat(value);
+    if (Number.isNaN(parsed)) {
+        return 0;
+    }
+    return parsed;
+};
+const amountDueDollarsFromInvoice = (invoice) => {
+    const amountDue = invoice.amountDue?.amount ?? 0;
+    return amountDue.toFixed(2);
+};
+/**
+ * Build the invoice-scoped Record Payment body from the form draft. Amount stays
+ * in dollars for the invoice endpoint.
+ */
+const localDataToInvoiceRecordPaymentBody = (localData) => {
+    const gateway = trimOrUndefined(localData.gateway);
+    const date = localData.date.trim();
+    const referenceNumber = trimOrUndefined(localData.referenceNumber);
+    return {
+        amount: dollarsFromAmountString(localData.amount),
+        payment_method: localData.paymentMethod,
+        ...(gateway != null ? { gateway } : {}),
+        ...(date !== '' ? { date } : {}),
+        ...(referenceNumber != null ? { reference_number: referenceNumber } : {}),
+    };
+};
+exports.localDataToInvoiceRecordPaymentBody = localDataToInvoiceRecordPaymentBody;
+/**
+ * Build the Record Payment request body from the form draft. Amount stays in
+ * dollars; the comment maps to `notes`, transaction id to `id_at_gateway`,
+ * and the linked invoice into `linked_invoices`. Currency is locked to USD.
+ */
+const localDataToRecordPaymentPayload = (localData) => {
+    const amount = dollarsFromAmountString(localData.amount);
+    const gateway = trimOrUndefined(localData.gateway);
+    const date = localData.date.trim();
+    const transactionId = trimOrUndefined(localData.transactionId);
+    const referenceNumber = trimOrUndefined(localData.referenceNumber);
+    const linkedInvoice = trimOrUndefined(localData.invoiceToLink);
+    const notes = trimOrUndefined(localData.comment);
+    return {
+        amount,
+        currency_code: 'USD',
+        customer_id: localData.customerId,
+        payment_method: localData.paymentMethod,
+        status: 'success',
+        type: 'payment',
+        ...(gateway != null ? { gateway } : {}),
+        ...(date !== '' ? { date } : {}),
+        ...(transactionId != null ? { id_at_gateway: transactionId } : {}),
+        ...(referenceNumber != null ? { reference_number: referenceNumber } : {}),
+        ...(linkedInvoice != null
+            ? { linked_invoices: [{ applied_amount: amount, invoice_id: linkedInvoice }] }
+            : {}),
+        ...(notes != null ? { notes } : {}),
+    };
+};
+exports.localDataToRecordPaymentPayload = localDataToRecordPaymentPayload;
+const initializeRecordPaymentDraftFromInvoice = (invoice) => ({
+    ...recordPaymentFormConfig_1.initialRecordPaymentFormLocalData,
+    amount: amountDueDollarsFromInvoice(invoice),
+    customerId: invoice.customerID,
+    date: (0, zeniDayJS_1.dateNow)().format('YYYY-MM-DD'),
+    invoiceToLink: invoice.id,
+});
+exports.initializeRecordPaymentDraftFromInvoice = initializeRecordPaymentDraftFromInvoice;

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

@@ -0,0 +1,17 @@
+import { ID } from '../../../commonStateTypes/common';
+import { ZeniAPIStatus } from '../../../responsePayload';
+import { RecordPaymentFormLocalData, RecordPaymentState } from './recordPaymentState';
+export declare const initialState: RecordPaymentState;
+export declare const initializeRecordPaymentDraft: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    localData: RecordPaymentFormLocalData;
+    contextInvoiceId?: ID;
+}, "invoicingRecordPayment/initializeRecordPaymentDraft">, updateRecordPaymentFormDraft: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    localData: RecordPaymentFormLocalData;
+}, "invoicingRecordPayment/updateRecordPaymentFormDraft">, submitRecordPayment: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[invoiceId?: string | undefined], {
+    invoiceId: string | undefined;
+}, "invoicingRecordPayment/submitRecordPayment", never, never>, recordPaymentSuccess: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    invoiceId?: ID;
+    transactionId?: ID;
+}, "invoicingRecordPayment/recordPaymentSuccess">, recordPaymentFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<ZeniAPIStatus<Record<string, unknown>>, "invoicingRecordPayment/recordPaymentFailure">, resetRecordPayment: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingRecordPayment/resetRecordPayment">;
+declare const _default: import("redux").Reducer<RecordPaymentState>;
+export default _default;

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

@@ -0,0 +1,65 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resetRecordPayment = exports.recordPaymentFailure = exports.recordPaymentSuccess = exports.submitRecordPayment = exports.updateRecordPaymentFormDraft = exports.initializeRecordPaymentDraft = exports.initialState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const recordPaymentFormConfig_1 = require("./recordPaymentFormConfig");
+exports.initialState = {
+    fetchState: 'Not-Started',
+    error: undefined,
+    contextInvoiceId: undefined,
+    newPaymentDraft: { ...recordPaymentFormConfig_1.initialRecordPaymentFormLocalData },
+    recordedInvoiceId: undefined,
+    recordedTransactionId: undefined,
+    hasValidState() {
+        return this.fetchState === 'Completed';
+    },
+};
+const recordPaymentSlice = (0, toolkit_1.createSlice)({
+    name: 'invoicingRecordPayment',
+    initialState: exports.initialState,
+    reducers: {
+        initializeRecordPaymentDraft(draft, action) {
+            draft.contextInvoiceId = action.payload.contextInvoiceId;
+            draft.newPaymentDraft = action.payload.localData;
+            draft.fetchState = 'Not-Started';
+            draft.error = undefined;
+            draft.recordedInvoiceId = undefined;
+            draft.recordedTransactionId = undefined;
+        },
+        updateRecordPaymentFormDraft(draft, action) {
+            draft.newPaymentDraft = action.payload.localData;
+        },
+        submitRecordPayment: {
+            prepare(invoiceId) {
+                return { payload: { invoiceId } };
+            },
+            reducer(draft) {
+                draft.fetchState = 'In-Progress';
+                draft.error = undefined;
+                draft.recordedInvoiceId = undefined;
+                draft.recordedTransactionId = undefined;
+            },
+        },
+        recordPaymentSuccess(draft, action) {
+            draft.fetchState = 'Completed';
+            draft.error = undefined;
+            draft.recordedInvoiceId = action.payload.invoiceId;
+            draft.recordedTransactionId = action.payload.transactionId;
+        },
+        recordPaymentFailure(draft, action) {
+            draft.fetchState = 'Error';
+            draft.error = action.payload;
+        },
+        resetRecordPayment(draft) {
+            draft.fetchState = 'Not-Started';
+            draft.error = undefined;
+            draft.contextInvoiceId = undefined;
+            draft.recordedInvoiceId = undefined;
+            draft.recordedTransactionId = undefined;
+            draft.newPaymentDraft = { ...recordPaymentFormConfig_1.initialRecordPaymentFormLocalData };
+        },
+    },
+});
+_a = recordPaymentSlice.actions, exports.initializeRecordPaymentDraft = _a.initializeRecordPaymentDraft, exports.updateRecordPaymentFormDraft = _a.updateRecordPaymentFormDraft, exports.submitRecordPayment = _a.submitRecordPayment, exports.recordPaymentSuccess = _a.recordPaymentSuccess, exports.recordPaymentFailure = _a.recordPaymentFailure, exports.resetRecordPayment = _a.resetRecordPayment;
+exports.default = recordPaymentSlice.reducer;

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

@@ -0,0 +1,30 @@
+import { ID } from '../../../commonStateTypes/common';
+import { SelectorView } from '../../../commonStateTypes/viewAndReport/viewAndReport';
+import { RootState } from '../../../reducer';
+import { RecordPaymentFormLocalData } from './recordPaymentState';
+export interface InvoicingRecordPaymentView extends SelectorView {
+    recordedInvoiceId?: ID;
+    recordedTransactionId?: ID;
+}
+/**
+ * Single bundled view for the record-payment submit lifecycle — carries the
+ * submit fetch state/error and the ids produced on success.
+ */
+export declare const getRecordPaymentView: (state: RootState) => InvoicingRecordPaymentView;
+/**
+ * Bundled view for the Record Payment form screen: the draft `localData`, the
+ * CES-owned payment-method / gateway value sets, and the submit fetch state.
+ */
+export interface RecordPaymentFormView extends SelectorView {
+    gatewayValues: string[];
+    localData: RecordPaymentFormLocalData;
+    paymentMethodValues: string[];
+    contextInvoiceId?: ID;
+}
+export declare const getRecordPaymentFormView: (state: RootState) => RecordPaymentFormView;
+export interface RecordPaymentInvoiceOption {
+    amountDue: number;
+    id: ID;
+    invoiceNumber: string;
+}
+export declare const getRecordPaymentInvoiceOptions: (state: RootState, customerId: ID) => RecordPaymentInvoiceOption[];