@zeniai/client-epic-state 5.1.34-betaAK1 → 5.1.34-betaAK3

package/lib/entity/invoicing/coupon/couponConstants.d.ts

@@ -0,0 +1,11 @@
+import { InvoicingFormOption } from '../invoicingCommonPayload';
+import { InvoicingCouponApplyOn, InvoicingCouponDurationType, InvoicingCouponPeriodUnit, InvoicingDiscountType } from './couponPayload';
+/**
+ * Coupon form select options. Single source of truth (CES-owned) for the value
+ * sets that back the coupon's string-union domain fields; surfaced to the form
+ * via `getInvoicingCouponFormView` so web-components need not hardcode them.
+ */
+export declare const INVOICING_DISCOUNT_TYPE_OPTIONS: readonly InvoicingFormOption<InvoicingDiscountType>[];
+export declare const INVOICING_COUPON_DURATION_TYPE_OPTIONS: readonly InvoicingFormOption<InvoicingCouponDurationType>[];
+export declare const INVOICING_COUPON_PERIOD_UNIT_OPTIONS: readonly InvoicingFormOption<InvoicingCouponPeriodUnit>[];
+export declare const INVOICING_COUPON_APPLY_ON_OPTIONS: readonly InvoicingFormOption<InvoicingCouponApplyOn>[];

package/lib/entity/invoicing/coupon/couponConstants.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.INVOICING_COUPON_APPLY_ON_OPTIONS = exports.INVOICING_COUPON_PERIOD_UNIT_OPTIONS = exports.INVOICING_COUPON_DURATION_TYPE_OPTIONS = exports.INVOICING_DISCOUNT_TYPE_OPTIONS = void 0;
+/**
+ * Coupon form select options. Single source of truth (CES-owned) for the value
+ * sets that back the coupon's string-union domain fields; surfaced to the form
+ * via `getInvoicingCouponFormView` so web-components need not hardcode them.
+ */
+exports.INVOICING_DISCOUNT_TYPE_OPTIONS = [
+    { label: 'Percentage', value: 'percentage' },
+    { label: 'Fixed amount', value: 'fixed_amount' },
+    { label: 'Offer quantity', value: 'offer_quantity' },
+];
+exports.INVOICING_COUPON_DURATION_TYPE_OPTIONS = [
+    { label: 'One time', value: 'one_time' },
+    { label: 'Forever', value: 'forever' },
+    { label: 'Limited period', value: 'limited_period' },
+];
+exports.INVOICING_COUPON_PERIOD_UNIT_OPTIONS = [
+    { label: 'Day', value: 'day' },
+    { label: 'Week', value: 'week' },
+    { label: 'Month', value: 'month' },
+    { label: 'Year', value: 'year' },
+];
+exports.INVOICING_COUPON_APPLY_ON_OPTIONS = [
+    { label: 'Invoice amount', value: 'invoice_amount' },
+    { label: 'Each specified item', value: 'each_specified_item' },
+    { label: 'Specified items total', value: 'specified_items_total' },
+];

package/lib/entity/invoicing/coupon/couponPayload.d.ts

@@ -1,9 +1,12 @@
+import { InvoicingCoupon, InvoicingDiscountKPIs } from './couponState';
 export type InvoicingDiscountType = 'percentage' | 'fixed_amount' | 'offer_quantity';
 export type InvoicingCouponDurationType = 'one_time' | 'forever' | 'limited_period';
 export type InvoicingCouponStatus = 'active' | 'expired' | 'archived';
-export interface InvoicingCoupon {
+export type InvoicingCouponApplyOn = 'invoice_amount' | 'each_specified_item' | 'specified_items_total';
+export type InvoicingCouponPeriodUnit = 'day' | 'week' | 'month' | 'year';
+export interface InvoicingCouponPayload {
     id: string;
-    apply_on?: string;
+    apply_on?: InvoicingCouponApplyOn;
     coupon_code?: string;
     created_at?: string;
     currency_code?: string;
@@ -18,7 +21,7 @@ export interface InvoicingCoupon {
     max_redemptions?: number;
     name?: string;
     period?: number;
-    period_unit?: string;
+    period_unit?: InvoicingCouponPeriodUnit;
     redemptions?: number;
     restricted_products?: string[];
     rev_rec_treatment?: string;
@@ -42,9 +45,11 @@ export interface InvoicingCouponSet {
     redeemed_count?: number;
     total_count?: number;
 }
-export interface InvoicingDiscountKPIs {
+export interface InvoicingDiscountKPIsPayload {
     total_active: number;
     total_discounted_amount: number;
     total_expired: number;
     total_redemptions: number;
 }
+export declare const mapInvoicingCouponPayloadToState: (payload: InvoicingCouponPayload) => InvoicingCoupon;
+export declare const mapInvoicingDiscountKPIsPayloadToState: (payload: InvoicingDiscountKPIsPayload) => InvoicingDiscountKPIs;

package/lib/entity/invoicing/coupon/couponPayload.js

@@ -1,2 +1,48 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapInvoicingDiscountKPIsPayloadToState = exports.mapInvoicingCouponPayloadToState = void 0;
+const amount_1 = require("../../../commonStateTypes/amount");
+const zeniDayJS_1 = require("../../../zeniDayJS");
+// ── Payload → State mappers (snake_case wire shape → camelCase domain shape) ──
+const DEFAULT_CURRENCY_CODE = 'USD';
+const DEFAULT_CURRENCY_SYMBOL = '$';
+const mapInvoicingCouponPayloadToState = (payload) => {
+    const currencyCode = payload.currency_code ?? DEFAULT_CURRENCY_CODE;
+    const currencySymbol = DEFAULT_CURRENCY_SYMBOL;
+    return {
+        id: payload.id,
+        applyOn: payload.apply_on,
+        couponCode: payload.coupon_code,
+        createdAt: payload.created_at != null ? (0, zeniDayJS_1.date)(payload.created_at) : undefined,
+        currencyCode: payload.currency_code,
+        discountAmount: payload.discount_amount != null
+            ? (0, amount_1.toAmount)(payload.discount_amount, currencyCode, currencySymbol)
+            : undefined,
+        discountPercentage: payload.discount_percentage,
+        discountQuantity: payload.discount_quantity,
+        discountType: payload.discount_type,
+        durationType: payload.duration_type,
+        invoiceName: payload.invoice_name,
+        invoiceNotes: payload.invoice_notes,
+        itemConstraints: payload.item_constraints,
+        maxRedemptions: payload.max_redemptions,
+        name: payload.name,
+        period: payload.period,
+        periodUnit: payload.period_unit,
+        redemptions: payload.redemptions,
+        restrictedProducts: payload.restricted_products,
+        revRecTreatment: payload.rev_rec_treatment,
+        status: payload.status,
+        updatedAt: payload.updated_at != null ? (0, zeniDayJS_1.date)(payload.updated_at) : undefined,
+        validFrom: payload.valid_from != null ? (0, zeniDayJS_1.date)(payload.valid_from) : undefined,
+        validTill: payload.valid_till != null ? (0, zeniDayJS_1.date)(payload.valid_till) : undefined,
+    };
+};
+exports.mapInvoicingCouponPayloadToState = mapInvoicingCouponPayloadToState;
+const mapInvoicingDiscountKPIsPayloadToState = (payload) => ({
+    totalActive: payload.total_active,
+    totalDiscountedAmount: (0, amount_1.toAmount)(payload.total_discounted_amount, DEFAULT_CURRENCY_CODE, DEFAULT_CURRENCY_SYMBOL),
+    totalExpired: payload.total_expired,
+    totalRedemptions: payload.total_redemptions,
+});
+exports.mapInvoicingDiscountKPIsPayloadToState = mapInvoicingDiscountKPIsPayloadToState;

package/lib/entity/invoicing/coupon/couponReducer.d.ts

@@ -1,10 +1,9 @@
 import { UpdateType } from '../../../commonStateTypes/common';
-import { InvoicingCoupon } from './couponPayload';
+import { InvoicingCouponPayload } from './couponPayload';
 import { InvoicingCouponState } from './couponState';
 export declare const initialState: InvoicingCouponState;
-export declare const updateInvoicingCoupons: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[items: InvoicingCoupon[], updateType?: UpdateType | undefined], {
-    items: InvoicingCoupon[];
-    updateType: UpdateType | undefined;
-}, "invoicingCoupon/updateInvoicingCoupons", never, never>, removeInvoicingCoupon: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "invoicingCoupon/removeInvoicingCoupon">, clearAllInvoicingCoupons: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingCoupon/clearAllInvoicingCoupons">;
+export declare const updateInvoicingCoupons: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: InvoicingCouponPayload[], updateType?: UpdateType | undefined], InvoicingCouponPayload[], "invoicingCoupon/updateInvoicingCoupons", never, {
+    updateType: UpdateType;
+}>, removeInvoicingCoupon: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "invoicingCoupon/removeInvoicingCoupon">, clearAllInvoicingCoupons: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingCoupon/clearAllInvoicingCoupons">;
 declare const _default: import("redux").Reducer<InvoicingCouponState>;
 export default _default;

package/lib/entity/invoicing/coupon/couponReducer.js

@@ -1,8 +1,13 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.clearAllInvoicingCoupons = exports.removeInvoicingCoupon = exports.updateInvoicingCoupons = exports.initialState = void 0;
 const toolkit_1 = require("@reduxjs/toolkit");
+const assignWith_1 = __importDefault(require("lodash/assignWith"));
+const couponPayload_1 = require("./couponPayload");
 exports.initialState = { couponByID: {} };
 const coupon = (0, toolkit_1.createSlice)({
     name: 'invoicingCoupon',
@@ -10,24 +15,33 @@ const coupon = (0, toolkit_1.createSlice)({
     reducers: {
         updateInvoicingCoupons: {
             reducer(draft, action) {
-                if (action.payload.updateType === 'replace') {
-                    draft.couponByID = {};
-                }
-                action.payload.items.forEach((item) => {
-                    draft.couponByID[item.id] = item;
-                });
+                doUpdateInvoicingCoupons(draft.couponByID, action.payload, action.meta.updateType);
             },
-            prepare(items, updateType) {
-                return { payload: { items, updateType } };
+            prepare(payload, updateType = 'replace') {
+                return { payload, meta: { updateType } };
             },
         },
         removeInvoicingCoupon(draft, action) {
             delete draft.couponByID[action.payload];
         },
         clearAllInvoicingCoupons(draft) {
-            draft.couponByID = {};
+            Object.assign(draft, exports.initialState);
         },
     },
 });
 _a = coupon.actions, exports.updateInvoicingCoupons = _a.updateInvoicingCoupons, exports.removeInvoicingCoupon = _a.removeInvoicingCoupon, exports.clearAllInvoicingCoupons = _a.clearAllInvoicingCoupons;
 exports.default = coupon.reducer;
+/**
+ * Helper functions.
+ */
+function doUpdateInvoicingCoupons(draft, payload, updateType) {
+    payload.forEach((couponPayload) => {
+        const latestCoupon = (0, couponPayload_1.mapInvoicingCouponPayloadToState)(couponPayload);
+        if (latestCoupon.id in draft && updateType === 'merge') {
+            (0, assignWith_1.default)(draft[latestCoupon.id], latestCoupon, (objValue, srcValue) => (srcValue == null ? objValue : srcValue));
+        }
+        else {
+            draft[latestCoupon.id] = latestCoupon;
+        }
+    });
+}

package/lib/entity/invoicing/coupon/couponSelector.d.ts

@@ -0,0 +1,5 @@
+import { ID } from '../../../commonStateTypes/common';
+import { RootState } from '../../../reducer';
+import { InvoicingCoupon } from './couponState';
+export declare const getInvoicingCouponById: (state: RootState, id: ID) => InvoicingCoupon | undefined;
+export declare const getInvoicingCouponsByIds: (state: RootState, ids: ID[]) => InvoicingCoupon[];

package/lib/entity/invoicing/coupon/couponSelector.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInvoicingCouponsByIds = exports.getInvoicingCouponById = void 0;
+const getInvoicingCouponById = (state, id) => state.invoicingCouponState.couponByID[id];
+exports.getInvoicingCouponById = getInvoicingCouponById;
+const getInvoicingCouponsByIds = (state, ids) => ids
+    .map((id) => state.invoicingCouponState.couponByID[id])
+    .filter((coupon) => coupon != null);
+exports.getInvoicingCouponsByIds = getInvoicingCouponsByIds;

package/lib/entity/invoicing/coupon/couponState.d.ts

@@ -1,5 +1,39 @@
+import { Amount } from '../../../commonStateTypes/amount';
 import { ID } from '../../../commonStateTypes/common';
-import { InvoicingCoupon } from './couponPayload';
+import { ZeniDate } from '../../../zeniDayJS';
+import { InvoicingCouponApplyOn, InvoicingCouponDurationType, InvoicingCouponPeriodUnit, InvoicingCouponStatus, InvoicingDiscountType } from './couponPayload';
+export interface InvoicingCoupon {
+    id: ID;
+    applyOn?: InvoicingCouponApplyOn;
+    couponCode?: string;
+    createdAt?: ZeniDate;
+    currencyCode?: string;
+    discountAmount?: Amount;
+    discountPercentage?: number;
+    discountQuantity?: number;
+    discountType?: InvoicingDiscountType;
+    durationType?: InvoicingCouponDurationType;
+    invoiceName?: string;
+    invoiceNotes?: string;
+    itemConstraints?: Record<string, unknown>[];
+    maxRedemptions?: number;
+    name?: string;
+    period?: number;
+    periodUnit?: InvoicingCouponPeriodUnit;
+    redemptions?: number;
+    restrictedProducts?: ID[];
+    revRecTreatment?: string;
+    status?: InvoicingCouponStatus;
+    updatedAt?: ZeniDate;
+    validFrom?: ZeniDate;
+    validTill?: ZeniDate;
+}
+export interface InvoicingDiscountKPIs {
+    totalActive: number;
+    totalDiscountedAmount: Amount;
+    totalExpired: number;
+    totalRedemptions: number;
+}
 export interface InvoicingCouponState {
     couponByID: Record<ID, InvoicingCoupon>;
 }

package/lib/entity/invoicing/invoice/invoicePayload.d.ts

@@ -1,6 +1,7 @@
 import { InvoicingBillingAddressPayload, InvoicingPriceType } from '../invoicingCommonPayload';
+import { InvoicingInvoice, InvoicingInvoiceKPIs } from './invoiceState';
 export type InvoicingInvoiceStatus = 'paid' | 'partially_paid' | 'posted' | 'payment_due' | 'not_paid' | 'voided' | 'pending' | 'draft';
-export interface InvoicingLineItem {
+export interface InvoicingLineItemPayload {
     amount: number;
     description: string;
     quantity: number;
@@ -19,7 +20,7 @@ export interface InvoicingLineItem {
     tax_rate?: number;
     usage_percentage?: number;
 }
-export interface InvoicingLinkedPayment {
+export interface InvoicingLinkedPaymentPayload {
     applied_amount: number;
     txn_id: string;
     applied_at?: string;
@@ -27,23 +28,23 @@ export interface InvoicingLinkedPayment {
     txn_date?: string;
     txn_status?: string;
 }
-export interface InvoicingIssuedCreditNote {
+export interface InvoicingIssuedCreditNotePayload {
     cn_id: string;
     cn_status: string;
     cn_total: number;
 }
-export interface InvoicingDunningAttempt {
+export interface InvoicingDunningAttemptPayload {
     attempt: number;
     created_at?: string;
     dunning_type?: string;
     transaction_id?: string;
 }
-export interface InvoicingInvoiceNote {
+export interface InvoicingInvoiceNotePayload {
     note: string;
     entity_id?: string;
     entity_type?: string;
 }
-export interface InvoicingInvoice {
+export interface InvoicingInvoicePayload {
     customer_id: string;
     date: string;
     id: string;
@@ -61,17 +62,17 @@ export interface InvoicingInvoice {
     customer_email?: string;
     customer_name?: string;
     due_date?: string;
-    dunning_attempts?: InvoicingDunningAttempt[];
+    dunning_attempts?: InvoicingDunningAttemptPayload[];
     dunning_status?: string;
     first_invoice?: boolean;
     generated_at?: string;
     has_advance_charges?: boolean;
-    issued_credit_notes?: InvoicingIssuedCreditNote[];
-    line_items?: InvoicingLineItem[];
-    linked_payments?: InvoicingLinkedPayment[];
+    issued_credit_notes?: InvoicingIssuedCreditNotePayload[];
+    line_items?: InvoicingLineItemPayload[];
+    linked_payments?: InvoicingLinkedPaymentPayload[];
     net_term_days?: number;
     next_retry_at?: string;
-    notes?: InvoicingInvoiceNote[];
+    notes?: InvoicingInvoiceNotePayload[];
     paid_at?: string;
     po_number?: string;
     price_type?: InvoicingPriceType;
@@ -85,9 +86,11 @@ export interface InvoicingInvoice {
     updated_at?: string;
     write_off_amount?: number;
 }
-export interface InvoicingInvoiceKPIs {
+export interface InvoicingInvoiceKPIsPayload {
     due_total: number;
     paid_total: number;
     pending_total: number;
     total_invoiced: number;
 }
+export declare const mapInvoicingInvoicePayloadToState: (payload: InvoicingInvoicePayload) => InvoicingInvoice;
+export declare const mapInvoicingInvoiceKPIsPayloadToState: (payload: InvoicingInvoiceKPIsPayload) => InvoicingInvoiceKPIs;

package/lib/entity/invoicing/invoice/invoicePayload.js

@@ -1,2 +1,120 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapInvoicingInvoiceKPIsPayloadToState = exports.mapInvoicingInvoicePayloadToState = void 0;
+const amount_1 = require("../../../commonStateTypes/amount");
+const zeniDayJS_1 = require("../../../zeniDayJS");
+// ── Payload → State mappers (snake_case wire shape → camelCase domain shape) ──
+const DEFAULT_CURRENCY_CODE = 'USD';
+const DEFAULT_CURRENCY_SYMBOL = '$';
+const mapLineItem = (payload, currencyCode, currencySymbol) => ({
+    amount: (0, amount_1.toAmount)(payload.amount, currencyCode, currencySymbol),
+    description: payload.description,
+    quantity: payload.quantity,
+    unitAmount: (0, amount_1.toAmount)(payload.unit_amount, currencyCode, currencySymbol),
+    dateFrom: payload.date_from != null ? (0, zeniDayJS_1.date)(payload.date_from) : undefined,
+    dateTo: payload.date_to != null ? (0, zeniDayJS_1.date)(payload.date_to) : undefined,
+    discountAmount: payload.discount_amount != null
+        ? (0, amount_1.toAmount)(payload.discount_amount, currencyCode, currencySymbol)
+        : undefined,
+    entityDescription: payload.entity_description,
+    entityType: payload.entity_type,
+    id: payload.id,
+    isTaxed: payload.is_taxed,
+    itemLevelDiscountAmount: payload.item_level_discount_amount != null
+        ? (0, amount_1.toAmount)(payload.item_level_discount_amount, currencyCode, currencySymbol)
+        : undefined,
+    subscriptionID: payload.subscription_id,
+    taxAmount: payload.tax_amount != null
+        ? (0, amount_1.toAmount)(payload.tax_amount, currencyCode, currencySymbol)
+        : undefined,
+    taxExemptReason: payload.tax_exempt_reason,
+    taxRate: payload.tax_rate,
+    usagePercentage: payload.usage_percentage,
+});
+const mapLinkedPayment = (payload, currencyCode, currencySymbol) => ({
+    appliedAmount: (0, amount_1.toAmount)(payload.applied_amount, currencyCode, currencySymbol),
+    txnID: payload.txn_id,
+    appliedAt: payload.applied_at != null ? (0, zeniDayJS_1.date)(payload.applied_at) : undefined,
+    txnAmount: payload.txn_amount != null
+        ? (0, amount_1.toAmount)(payload.txn_amount, currencyCode, currencySymbol)
+        : undefined,
+    txnDate: payload.txn_date != null ? (0, zeniDayJS_1.date)(payload.txn_date) : undefined,
+    txnStatus: payload.txn_status,
+});
+const mapIssuedCreditNote = (payload, currencyCode, currencySymbol) => ({
+    cnID: payload.cn_id,
+    cnStatus: payload.cn_status,
+    cnTotal: (0, amount_1.toAmount)(payload.cn_total, currencyCode, currencySymbol),
+});
+const mapDunningAttempt = (payload) => ({
+    attempt: payload.attempt,
+    createdAt: payload.created_at != null ? (0, zeniDayJS_1.date)(payload.created_at) : undefined,
+    dunningType: payload.dunning_type,
+    transactionID: payload.transaction_id,
+});
+const mapInvoiceNote = (payload) => ({
+    note: payload.note,
+    entityID: payload.entity_id,
+    entityType: payload.entity_type,
+});
+const mapInvoicingInvoicePayloadToState = (payload) => {
+    const currencyCode = payload.currency_code ?? DEFAULT_CURRENCY_CODE;
+    const currencySymbol = DEFAULT_CURRENCY_SYMBOL;
+    const toAmt = (value) => (0, amount_1.toAmount)(value, currencyCode, currencySymbol);
+    return {
+        customerID: payload.customer_id,
+        date: (0, zeniDayJS_1.date)(payload.date),
+        id: payload.id,
+        status: payload.status,
+        total: toAmt(payload.total),
+        adjustmentCreditNotes: payload.adjustment_credit_notes,
+        amountAdjusted: payload.amount_adjusted != null ? toAmt(payload.amount_adjusted) : undefined,
+        amountDue: payload.amount_due != null ? toAmt(payload.amount_due) : undefined,
+        amountPaid: payload.amount_paid != null ? toAmt(payload.amount_paid) : undefined,
+        amountToCollect: payload.amount_to_collect != null
+            ? toAmt(payload.amount_to_collect)
+            : undefined,
+        billingAddress: payload.billing_address,
+        createdAt: payload.created_at != null ? (0, zeniDayJS_1.date)(payload.created_at) : undefined,
+        creditsApplied: payload.credits_applied != null ? toAmt(payload.credits_applied) : undefined,
+        currencyCode: payload.currency_code,
+        customerEmail: payload.customer_email,
+        customerName: payload.customer_name,
+        dueDate: payload.due_date != null ? (0, zeniDayJS_1.date)(payload.due_date) : undefined,
+        dunningAttempts: payload.dunning_attempts?.map(mapDunningAttempt),
+        dunningStatus: payload.dunning_status,
+        firstInvoice: payload.first_invoice,
+        generatedAt: payload.generated_at != null ? (0, zeniDayJS_1.date)(payload.generated_at) : undefined,
+        hasAdvanceCharges: payload.has_advance_charges,
+        issuedCreditNotes: payload.issued_credit_notes?.map((note) => mapIssuedCreditNote(note, currencyCode, currencySymbol)),
+        lineItems: payload.line_items?.map((item) => mapLineItem(item, currencyCode, currencySymbol)),
+        linkedPayments: payload.linked_payments?.map((payment) => mapLinkedPayment(payment, currencyCode, currencySymbol)),
+        netTermDays: payload.net_term_days,
+        nextRetryAt: payload.next_retry_at != null ? (0, zeniDayJS_1.date)(payload.next_retry_at) : undefined,
+        notes: payload.notes?.map(mapInvoiceNote),
+        paidAt: payload.paid_at != null ? (0, zeniDayJS_1.date)(payload.paid_at) : undefined,
+        poNumber: payload.po_number,
+        priceType: payload.price_type,
+        recurring: payload.recurring,
+        roundOffAmount: payload.round_off_amount != null
+            ? toAmt(payload.round_off_amount)
+            : undefined,
+        shippingAddress: payload.shipping_address,
+        subscriptionID: payload.subscription_id,
+        subscriptionName: payload.subscription_name,
+        subTotal: payload.sub_total != null ? toAmt(payload.sub_total) : undefined,
+        tax: payload.tax != null ? toAmt(payload.tax) : undefined,
+        updatedAt: payload.updated_at != null ? (0, zeniDayJS_1.date)(payload.updated_at) : undefined,
+        writeOffAmount: payload.write_off_amount != null
+            ? toAmt(payload.write_off_amount)
+            : undefined,
+    };
+};
+exports.mapInvoicingInvoicePayloadToState = mapInvoicingInvoicePayloadToState;
+const mapInvoicingInvoiceKPIsPayloadToState = (payload) => ({
+    dueTotal: (0, amount_1.toAmount)(payload.due_total, DEFAULT_CURRENCY_CODE, DEFAULT_CURRENCY_SYMBOL),
+    paidTotal: (0, amount_1.toAmount)(payload.paid_total, DEFAULT_CURRENCY_CODE, DEFAULT_CURRENCY_SYMBOL),
+    pendingTotal: (0, amount_1.toAmount)(payload.pending_total, DEFAULT_CURRENCY_CODE, DEFAULT_CURRENCY_SYMBOL),
+    totalInvoiced: (0, amount_1.toAmount)(payload.total_invoiced, DEFAULT_CURRENCY_CODE, DEFAULT_CURRENCY_SYMBOL),
+});
+exports.mapInvoicingInvoiceKPIsPayloadToState = mapInvoicingInvoiceKPIsPayloadToState;

package/lib/entity/invoicing/invoice/invoiceReducer.d.ts

@@ -1,10 +1,9 @@
 import { UpdateType } from '../../../commonStateTypes/common';
-import { InvoicingInvoice } from './invoicePayload';
+import { InvoicingInvoicePayload } from './invoicePayload';
 import { InvoiceState } from './invoiceState';
 export declare const initialState: InvoiceState;
-export declare const updateInvoices: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[invoices: InvoicingInvoice[], updateType?: UpdateType | undefined], {
-    invoices: InvoicingInvoice[];
-    updateType: UpdateType | undefined;
-}, "invoicingInvoice/updateInvoices", never, never>, removeInvoice: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "invoicingInvoice/removeInvoice">, clearAllInvoices: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingInvoice/clearAllInvoices">;
+export declare const updateInvoices: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: InvoicingInvoicePayload[], updateType?: UpdateType | undefined], InvoicingInvoicePayload[], "invoicingInvoice/updateInvoices", never, {
+    updateType: UpdateType;
+}>, removeInvoice: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "invoicingInvoice/removeInvoice">, clearAllInvoices: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingInvoice/clearAllInvoices">;
 declare const _default: import("redux").Reducer<InvoiceState>;
 export default _default;

package/lib/entity/invoicing/invoice/invoiceReducer.js

@@ -1,8 +1,13 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.clearAllInvoices = exports.removeInvoice = exports.updateInvoices = exports.initialState = void 0;
 const toolkit_1 = require("@reduxjs/toolkit");
+const assignWith_1 = __importDefault(require("lodash/assignWith"));
+const invoicePayload_1 = require("./invoicePayload");
 exports.initialState = {
     invoiceByID: {},
 };
@@ -12,25 +17,33 @@ const invoice = (0, toolkit_1.createSlice)({
     reducers: {
         updateInvoices: {
             reducer(draft, action) {
-                const { invoices, updateType } = action.payload;
-                if (updateType === 'replace') {
-                    draft.invoiceByID = {};
-                }
-                invoices.forEach((invoice) => {
-                    draft.invoiceByID[invoice.id] = invoice;
-                });
+                doUpdateInvoices(draft.invoiceByID, action.payload, action.meta.updateType);
             },
-            prepare(invoices, updateType) {
-                return { payload: { invoices, updateType } };
+            prepare(payload, updateType = 'replace') {
+                return { payload, meta: { updateType } };
             },
         },
         removeInvoice(draft, action) {
             delete draft.invoiceByID[action.payload];
         },
         clearAllInvoices(draft) {
-            draft.invoiceByID = {};
+            Object.assign(draft, exports.initialState);
         },
     },
 });
 _a = invoice.actions, exports.updateInvoices = _a.updateInvoices, exports.removeInvoice = _a.removeInvoice, exports.clearAllInvoices = _a.clearAllInvoices;
 exports.default = invoice.reducer;
+/**
+ * Helper functions.
+ */
+function doUpdateInvoices(draft, payload, updateType) {
+    payload.forEach((invoicePayload) => {
+        const latestInvoice = (0, invoicePayload_1.mapInvoicingInvoicePayloadToState)(invoicePayload);
+        if (latestInvoice.id in draft && updateType === 'merge') {
+            (0, assignWith_1.default)(draft[latestInvoice.id], latestInvoice, (objValue, srcValue) => (srcValue == null ? objValue : srcValue));
+        }
+        else {
+            draft[latestInvoice.id] = latestInvoice;
+        }
+    });
+}

package/lib/entity/invoicing/invoice/invoiceSelector.d.ts

@@ -1,5 +1,5 @@
 import { ID } from '../../../commonStateTypes/common';
 import { RootState } from '../../../reducer';
-import { InvoicingInvoice } from './invoicePayload';
+import { InvoicingInvoice } from './invoiceState';
 export declare const getInvoiceById: (state: RootState, invoiceId: ID) => InvoicingInvoice | undefined;
 export declare const getInvoicesByIds: (state: RootState, invoiceIds: ID[]) => InvoicingInvoice[];

package/lib/entity/invoicing/invoice/invoiceState.d.ts

@@ -1,5 +1,99 @@
+import { Amount } from '../../../commonStateTypes/amount';
 import { ID } from '../../../commonStateTypes/common';
-import { InvoicingInvoice } from './invoicePayload';
+import { ZeniDate } from '../../../zeniDayJS';
+import { InvoicingBillingAddressPayload, InvoicingPriceType } from '../invoicingCommonPayload';
+import { InvoicingInvoiceStatus } from './invoicePayload';
+export interface InvoicingLineItem {
+    amount: Amount;
+    description: string;
+    quantity: number;
+    unitAmount: Amount;
+    dateFrom?: ZeniDate;
+    dateTo?: ZeniDate;
+    discountAmount?: Amount;
+    entityDescription?: string;
+    entityType?: string;
+    id?: ID;
+    isTaxed?: boolean;
+    itemLevelDiscountAmount?: Amount;
+    subscriptionID?: ID;
+    taxAmount?: Amount;
+    taxExemptReason?: string;
+    taxRate?: number;
+    usagePercentage?: number;
+}
+export interface InvoicingLinkedPayment {
+    appliedAmount: Amount;
+    txnID: ID;
+    appliedAt?: ZeniDate;
+    txnAmount?: Amount;
+    txnDate?: ZeniDate;
+    txnStatus?: string;
+}
+export interface InvoicingIssuedCreditNote {
+    cnID: ID;
+    cnStatus: string;
+    cnTotal: Amount;
+}
+export interface InvoicingDunningAttempt {
+    attempt: number;
+    createdAt?: ZeniDate;
+    dunningType?: string;
+    transactionID?: ID;
+}
+export interface InvoicingInvoiceNote {
+    note: string;
+    entityID?: ID;
+    entityType?: string;
+}
+export interface InvoicingInvoice {
+    customerID: ID;
+    date: ZeniDate;
+    id: ID;
+    status: InvoicingInvoiceStatus;
+    total: Amount;
+    adjustmentCreditNotes?: ID[];
+    amountAdjusted?: Amount;
+    amountDue?: Amount;
+    amountPaid?: Amount;
+    amountToCollect?: Amount;
+    billingAddress?: InvoicingBillingAddressPayload;
+    createdAt?: ZeniDate;
+    creditsApplied?: Amount;
+    currencyCode?: string;
+    customerEmail?: string;
+    customerName?: string;
+    dueDate?: ZeniDate;
+    dunningAttempts?: InvoicingDunningAttempt[];
+    dunningStatus?: string;
+    firstInvoice?: boolean;
+    generatedAt?: ZeniDate;
+    hasAdvanceCharges?: boolean;
+    issuedCreditNotes?: InvoicingIssuedCreditNote[];
+    lineItems?: InvoicingLineItem[];
+    linkedPayments?: InvoicingLinkedPayment[];
+    netTermDays?: number;
+    nextRetryAt?: ZeniDate;
+    notes?: InvoicingInvoiceNote[];
+    paidAt?: ZeniDate;
+    poNumber?: string;
+    priceType?: InvoicingPriceType;
+    recurring?: boolean;
+    roundOffAmount?: Amount;
+    shippingAddress?: InvoicingBillingAddressPayload;
+    subscriptionID?: ID;
+    subscriptionName?: string;
+    subTotal?: Amount;
+    tax?: Amount;
+    updatedAt?: ZeniDate;
+    writeOffAmount?: Amount;
+}
+export interface InvoicingInvoiceKPIs {
+    dueTotal: Amount;
+    paidTotal: Amount;
+    pendingTotal: Amount;
+    totalInvoiced: Amount;
+}
 export interface InvoiceState {
     invoiceByID: Record<ID, InvoicingInvoice>;
 }