@zeniai/client-epic-state 5.1.41-beta1ND → 5.1.41-betaAK1

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

@@ -0,0 +1,49 @@
+import { InvoicingCoupon } 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 type InvoicingCouponApplyOn = 'invoice_amount' | 'each_specified_item' | 'specified_items_total';
+export type InvoicingCouponPeriodUnit = 'day' | 'week' | 'month' | 'year';
+export interface InvoicingCouponPayload {
+    id: string;
+    apply_on?: InvoicingCouponApplyOn;
+    coupon_code?: string;
+    created_at?: string;
+    currency_code?: string;
+    currency_symbol?: string;
+    discount_amount?: number;
+    discount_percentage?: number;
+    discount_quantity?: number;
+    discount_type?: InvoicingDiscountType;
+    duration_type?: InvoicingCouponDurationType;
+    invoice_name?: string;
+    invoice_notes?: string;
+    item_constraints?: Record<string, unknown>[];
+    max_redemptions?: number;
+    name?: string;
+    period?: number;
+    period_unit?: InvoicingCouponPeriodUnit;
+    redemptions?: number;
+    restricted_products?: string[];
+    rev_rec_treatment?: string;
+    status?: InvoicingCouponStatus;
+    updated_at?: string;
+    valid_from?: string;
+    valid_till?: string;
+}
+export interface InvoicingCouponCode {
+    code: string;
+    coupon_id?: string;
+    coupon_set_id?: string;
+    status?: string;
+}
+export interface InvoicingCouponSet {
+    id: string;
+    archived_count?: number;
+    codes?: InvoicingCouponCode[];
+    coupon_id?: string;
+    name?: string;
+    redeemed_count?: number;
+    total_count?: number;
+}
+export declare const mapInvoicingCouponPayloadToState: (payload: InvoicingCouponPayload) => InvoicingCoupon;

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

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapInvoicingCouponPayloadToState = void 0;
+const amount_1 = require("../../../commonStateTypes/amount");
+const currencyHelper_1 = require("../../../commonStateTypes/currencyHelper");
+const zeniDayJS_1 = require("../../../zeniDayJS");
+// ── Payload → State mappers (snake_case wire shape → camelCase domain shape) ──
+const mapInvoicingCouponPayloadToState = (payload) => {
+    const currencyCode = payload.currency_code ?? currencyHelper_1.defaultCustomerCurrency.currencyCode;
+    const currencySymbol = payload.currency_symbol ?? currencyHelper_1.defaultCustomerCurrency.currencySymbol;
+    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;

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

@@ -0,0 +1,9 @@
+import { UpdateType } from '../../../commonStateTypes/common';
+import { InvoicingCouponPayload } from './couponPayload';
+import { InvoicingCouponState } from './couponState';
+export declare const initialState: InvoicingCouponState;
+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

@@ -0,0 +1,47 @@
+"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',
+    initialState: exports.initialState,
+    reducers: {
+        updateInvoicingCoupons: {
+            reducer(draft, action) {
+                doUpdateInvoicingCoupons(draft.couponByID, action.payload, action.meta.updateType);
+            },
+            prepare(payload, updateType = 'replace') {
+                return { payload, meta: { updateType } };
+            },
+        },
+        removeInvoicingCoupon(draft, action) {
+            delete draft.couponByID[action.payload];
+        },
+        clearAllInvoicingCoupons(draft) {
+            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

@@ -0,0 +1,33 @@
+import { Amount } from '../../../commonStateTypes/amount';
+import { ID } from '../../../commonStateTypes/common';
+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 InvoicingCouponState {
+    couponByID: Record<ID, InvoicingCoupon>;
+}

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

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

package/lib/entity/invoicing/creditNote/creditNotePayload.d.ts

@@ -0,0 +1,45 @@
+import { InvoicingPriceType } from '../invoicingCommonPayload';
+import { InvoicingCreditNote, InvoicingCreditNoteAllocation, InvoicingCreditNoteLineItem } from './creditNoteState';
+export type InvoicingCreditNoteStatus = 'adjusted' | 'refunded' | 'refund_due' | 'voided' | 'open' | 'closed' | 'partially_used';
+export type InvoicingCreditNoteType = 'adjustment' | 'refundable' | 'store' | 'referral';
+export interface InvoicingCreditNoteLineItemPayload {
+    amount: number;
+    description: string;
+    quantity: number;
+    unit_amount: number;
+    entity_type?: string;
+    id?: string;
+}
+export interface InvoicingCreditNoteAllocationPayload {
+    allocated_amount: number;
+    invoice_id: string;
+    allocated_at?: string;
+}
+export interface InvoicingCreditNotePayload {
+    id: string;
+    allocations?: InvoicingCreditNoteAllocationPayload[];
+    amount_allocated?: number;
+    amount_available?: number;
+    amount_refunded?: number;
+    create_reason_code?: string;
+    created_at?: string;
+    credit_note_number?: string;
+    currency_code?: string;
+    customer_id?: string;
+    customer_name?: string;
+    date?: string;
+    line_items?: InvoicingCreditNoteLineItemPayload[];
+    linked_refunds?: string[];
+    notes?: string;
+    price_type?: InvoicingPriceType;
+    reason_code?: string;
+    reference_invoice_id?: string;
+    status?: InvoicingCreditNoteStatus;
+    sub_total?: number;
+    subscription_id?: string;
+    total?: number;
+    type?: InvoicingCreditNoteType;
+}
+export declare const mapInvoicingCreditNoteLineItemPayloadToState: (payload: InvoicingCreditNoteLineItemPayload, currencyCode: string, currencySymbol: string) => InvoicingCreditNoteLineItem;
+export declare const mapInvoicingCreditNoteAllocationPayloadToState: (payload: InvoicingCreditNoteAllocationPayload, currencyCode: string, currencySymbol: string) => InvoicingCreditNoteAllocation;
+export declare const mapInvoicingCreditNotePayloadToState: (payload: InvoicingCreditNotePayload) => InvoicingCreditNote;

package/lib/entity/invoicing/creditNote/creditNotePayload.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapInvoicingCreditNotePayloadToState = exports.mapInvoicingCreditNoteAllocationPayloadToState = exports.mapInvoicingCreditNoteLineItemPayloadToState = 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 mapInvoicingCreditNoteLineItemPayloadToState = (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),
+    entityType: payload.entity_type,
+    id: payload.id,
+});
+exports.mapInvoicingCreditNoteLineItemPayloadToState = mapInvoicingCreditNoteLineItemPayloadToState;
+const mapInvoicingCreditNoteAllocationPayloadToState = (payload, currencyCode, currencySymbol) => ({
+    allocatedAmount: (0, amount_1.toAmount)(payload.allocated_amount, currencyCode, currencySymbol),
+    invoiceID: payload.invoice_id,
+    allocatedAt: payload.allocated_at != null ? (0, zeniDayJS_1.date)(payload.allocated_at) : undefined,
+});
+exports.mapInvoicingCreditNoteAllocationPayloadToState = mapInvoicingCreditNoteAllocationPayloadToState;
+const mapInvoicingCreditNotePayloadToState = (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 {
+        id: payload.id,
+        allocations: payload.allocations?.map((allocation) => (0, exports.mapInvoicingCreditNoteAllocationPayloadToState)(allocation, currencyCode, currencySymbol)),
+        amountAllocated: payload.amount_allocated != null
+            ? toAmt(payload.amount_allocated)
+            : undefined,
+        amountAvailable: payload.amount_available != null
+            ? toAmt(payload.amount_available)
+            : undefined,
+        amountRefunded: payload.amount_refunded != null
+            ? toAmt(payload.amount_refunded)
+            : undefined,
+        createReasonCode: payload.create_reason_code,
+        createdAt: payload.created_at != null ? (0, zeniDayJS_1.date)(payload.created_at) : undefined,
+        creditNoteNumber: payload.credit_note_number,
+        currencyCode: payload.currency_code,
+        customerID: payload.customer_id,
+        customerName: payload.customer_name,
+        date: payload.date != null ? (0, zeniDayJS_1.date)(payload.date) : undefined,
+        lineItems: payload.line_items?.map((lineItem) => (0, exports.mapInvoicingCreditNoteLineItemPayloadToState)(lineItem, currencyCode, currencySymbol)),
+        linkedRefunds: payload.linked_refunds,
+        notes: payload.notes,
+        priceType: payload.price_type,
+        reasonCode: payload.reason_code,
+        referenceInvoiceID: payload.reference_invoice_id,
+        status: payload.status,
+        subTotal: payload.sub_total != null ? toAmt(payload.sub_total) : undefined,
+        subscriptionID: payload.subscription_id,
+        total: payload.total != null ? toAmt(payload.total) : undefined,
+        type: payload.type,
+    };
+};
+exports.mapInvoicingCreditNotePayloadToState = mapInvoicingCreditNotePayloadToState;

package/lib/entity/invoicing/creditNote/creditNoteReducer.d.ts

@@ -0,0 +1,9 @@
+import { UpdateType } from '../../../commonStateTypes/common';
+import { InvoicingCreditNotePayload } from './creditNotePayload';
+import { InvoicingCreditNoteState } from './creditNoteState';
+export declare const initialState: InvoicingCreditNoteState;
+export declare const updateInvoicingCreditNotes: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: InvoicingCreditNotePayload[], updateType?: UpdateType | undefined], InvoicingCreditNotePayload[], "invoicingCreditNote/updateInvoicingCreditNotes", never, {
+    updateType: UpdateType;
+}>, removeInvoicingCreditNote: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "invoicingCreditNote/removeInvoicingCreditNote">, clearAllInvoicingCreditNotes: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingCreditNote/clearAllInvoicingCreditNotes">;
+declare const _default: import("redux").Reducer<InvoicingCreditNoteState>;
+export default _default;

package/lib/entity/invoicing/creditNote/creditNoteReducer.js

@@ -0,0 +1,49 @@
+"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.clearAllInvoicingCreditNotes = exports.removeInvoicingCreditNote = exports.updateInvoicingCreditNotes = exports.initialState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const assignWith_1 = __importDefault(require("lodash/assignWith"));
+const creditNotePayload_1 = require("./creditNotePayload");
+exports.initialState = {
+    creditNoteByID: {},
+};
+const creditNote = (0, toolkit_1.createSlice)({
+    name: 'invoicingCreditNote',
+    initialState: exports.initialState,
+    reducers: {
+        updateInvoicingCreditNotes: {
+            reducer(draft, action) {
+                doUpdateInvoicingCreditNotes(draft.creditNoteByID, action.payload, action.meta.updateType);
+            },
+            prepare(payload, updateType = 'replace') {
+                return { payload, meta: { updateType } };
+            },
+        },
+        removeInvoicingCreditNote(draft, action) {
+            delete draft.creditNoteByID[action.payload];
+        },
+        clearAllInvoicingCreditNotes(draft) {
+            Object.assign(draft, exports.initialState);
+        },
+    },
+});
+_a = creditNote.actions, exports.updateInvoicingCreditNotes = _a.updateInvoicingCreditNotes, exports.removeInvoicingCreditNote = _a.removeInvoicingCreditNote, exports.clearAllInvoicingCreditNotes = _a.clearAllInvoicingCreditNotes;
+exports.default = creditNote.reducer;
+/**
+ * Helper functions.
+ */
+function doUpdateInvoicingCreditNotes(draft, payload, updateType) {
+    payload.forEach((creditNotePayload) => {
+        const latestCreditNote = (0, creditNotePayload_1.mapInvoicingCreditNotePayloadToState)(creditNotePayload);
+        if (latestCreditNote.id in draft && updateType === 'merge') {
+            (0, assignWith_1.default)(draft[latestCreditNote.id], latestCreditNote, (objValue, srcValue) => (srcValue == null ? objValue : srcValue));
+        }
+        else {
+            draft[latestCreditNote.id] = latestCreditNote;
+        }
+    });
+}

package/lib/entity/invoicing/creditNote/creditNoteSelector.d.ts

@@ -0,0 +1,4 @@
+import { ID } from '../../../commonStateTypes/common';
+import { InvoicingCreditNote, InvoicingCreditNoteState } from './creditNoteState';
+export declare function getInvoicingCreditNotesByIds(creditNoteState: InvoicingCreditNoteState, ids: ID[]): InvoicingCreditNote[];
+export declare function getInvoicingCreditNoteById(creditNoteState: InvoicingCreditNoteState, id: ID): InvoicingCreditNote | undefined;

package/lib/entity/invoicing/creditNote/creditNoteSelector.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInvoicingCreditNotesByIds = getInvoicingCreditNotesByIds;
+exports.getInvoicingCreditNoteById = getInvoicingCreditNoteById;
+const get_1 = __importDefault(require("lodash/get"));
+function getInvoicingCreditNotesByIds(creditNoteState, ids) {
+    const creditNotes = ids
+        .map((id) => getInvoicingCreditNoteById(creditNoteState, id))
+        .filter((value) => value != null);
+    return creditNotes;
+}
+function getInvoicingCreditNoteById(creditNoteState, id) {
+    return (0, get_1.default)(creditNoteState.creditNoteByID, id);
+}

package/lib/entity/invoicing/creditNote/creditNoteState.d.ts

@@ -0,0 +1,46 @@
+import { Amount } from '../../../commonStateTypes/amount';
+import { ID } from '../../../commonStateTypes/common';
+import { ZeniDate } from '../../../zeniDayJS';
+import { InvoicingPriceType } from '../invoicingCommonPayload';
+import { InvoicingCreditNoteStatus, InvoicingCreditNoteType } from './creditNotePayload';
+export interface InvoicingCreditNoteLineItem {
+    amount: Amount;
+    description: string;
+    quantity: number;
+    unitAmount: Amount;
+    entityType?: string;
+    id?: ID;
+}
+export interface InvoicingCreditNoteAllocation {
+    allocatedAmount: Amount;
+    invoiceID: ID;
+    allocatedAt?: ZeniDate;
+}
+export interface InvoicingCreditNote {
+    id: ID;
+    allocations?: InvoicingCreditNoteAllocation[];
+    amountAllocated?: Amount;
+    amountAvailable?: Amount;
+    amountRefunded?: Amount;
+    createdAt?: ZeniDate;
+    createReasonCode?: string;
+    creditNoteNumber?: string;
+    currencyCode?: string;
+    customerID?: ID;
+    customerName?: string;
+    date?: ZeniDate;
+    lineItems?: InvoicingCreditNoteLineItem[];
+    linkedRefunds?: ID[];
+    notes?: string;
+    priceType?: InvoicingPriceType;
+    reasonCode?: string;
+    referenceInvoiceID?: ID;
+    status?: InvoicingCreditNoteStatus;
+    subscriptionID?: ID;
+    subTotal?: Amount;
+    total?: Amount;
+    type?: InvoicingCreditNoteType;
+}
+export interface InvoicingCreditNoteState {
+    creditNoteByID: Record<ID, InvoicingCreditNote>;
+}

package/lib/entity/invoicing/creditNote/creditNoteState.js

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

package/lib/entity/invoicing/dunningCase/dunningCasePayload.d.ts

@@ -0,0 +1,25 @@
+import { InvoicingDunningCase } from './dunningCaseState';
+export type InvoicingDunningStatus = 'Retrying' | 'Scheduled' | 'Manual Review' | 'Resolved' | 'Cancelled' | 'Paused';
+export interface InvoicingDunningCasePayload {
+    id: string;
+    status: InvoicingDunningStatus;
+    amount?: number;
+    attempts?: number;
+    created_at?: string;
+    currency_code?: string;
+    currency_symbol?: string;
+    customer?: string;
+    customer_email?: string;
+    customer_id?: string;
+    days_past_due?: number;
+    failure_reason?: string;
+    initials?: string;
+    invoice_id?: string;
+    last_attempt?: string;
+    max_attempts?: number;
+    next_retry?: string;
+    paused_reason?: string;
+    paused_until?: string;
+    subscription_id?: string;
+}
+export declare const mapInvoicingDunningCasePayloadToState: (payload: InvoicingDunningCasePayload) => InvoicingDunningCase;

package/lib/entity/invoicing/dunningCase/dunningCasePayload.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapInvoicingDunningCasePayloadToState = void 0;
+const amount_1 = require("../../../commonStateTypes/amount");
+const currencyHelper_1 = require("../../../commonStateTypes/currencyHelper");
+const zeniDayJS_1 = require("../../../zeniDayJS");
+// ── Payload → State mappers (snake_case wire shape → camelCase domain shape) ──
+const mapInvoicingDunningCasePayloadToState = (payload) => {
+    const currencyCode = payload.currency_code ?? currencyHelper_1.defaultCustomerCurrency.currencyCode;
+    const currencySymbol = payload.currency_symbol ?? currencyHelper_1.defaultCustomerCurrency.currencySymbol;
+    return {
+        id: payload.id,
+        status: payload.status,
+        amount: payload.amount != null
+            ? (0, amount_1.toAmount)(payload.amount, currencyCode, currencySymbol)
+            : undefined,
+        attempts: payload.attempts,
+        createdAt: payload.created_at != null ? (0, zeniDayJS_1.date)(payload.created_at) : undefined,
+        currencyCode: payload.currency_code,
+        customer: payload.customer,
+        customerEmail: payload.customer_email,
+        customerID: payload.customer_id,
+        daysPastDue: payload.days_past_due,
+        failureReason: payload.failure_reason,
+        initials: payload.initials,
+        invoiceID: payload.invoice_id,
+        lastAttempt: payload.last_attempt != null ? (0, zeniDayJS_1.date)(payload.last_attempt) : undefined,
+        maxAttempts: payload.max_attempts,
+        nextRetry: payload.next_retry != null ? (0, zeniDayJS_1.date)(payload.next_retry) : undefined,
+        pausedReason: payload.paused_reason,
+        pausedUntil: payload.paused_until != null ? (0, zeniDayJS_1.date)(payload.paused_until) : undefined,
+        subscriptionID: payload.subscription_id,
+    };
+};
+exports.mapInvoicingDunningCasePayloadToState = mapInvoicingDunningCasePayloadToState;

package/lib/entity/invoicing/dunningCase/dunningCaseReducer.d.ts

@@ -0,0 +1,9 @@
+import { UpdateType } from '../../../commonStateTypes/common';
+import { InvoicingDunningCasePayload } from './dunningCasePayload';
+import { InvoicingDunningCaseState } from './dunningCaseState';
+export declare const initialState: InvoicingDunningCaseState;
+export declare const updateInvoicingDunningCases: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: InvoicingDunningCasePayload[], updateType?: UpdateType | undefined], InvoicingDunningCasePayload[], "invoicingDunningCase/updateInvoicingDunningCases", never, {
+    updateType: UpdateType;
+}>, removeInvoicingDunningCase: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "invoicingDunningCase/removeInvoicingDunningCase">, clearAllInvoicingDunningCases: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingDunningCase/clearAllInvoicingDunningCases">;
+declare const _default: import("redux").Reducer<InvoicingDunningCaseState>;
+export default _default;

package/lib/entity/invoicing/dunningCase/dunningCaseReducer.js

@@ -0,0 +1,49 @@
+"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.clearAllInvoicingDunningCases = exports.removeInvoicingDunningCase = exports.updateInvoicingDunningCases = exports.initialState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const assignWith_1 = __importDefault(require("lodash/assignWith"));
+const dunningCasePayload_1 = require("./dunningCasePayload");
+exports.initialState = {
+    dunningCaseByID: {},
+};
+const dunningCase = (0, toolkit_1.createSlice)({
+    name: 'invoicingDunningCase',
+    initialState: exports.initialState,
+    reducers: {
+        updateInvoicingDunningCases: {
+            reducer(draft, action) {
+                doUpdateInvoicingDunningCases(draft.dunningCaseByID, action.payload, action.meta.updateType);
+            },
+            prepare(payload, updateType = 'replace') {
+                return { payload, meta: { updateType } };
+            },
+        },
+        removeInvoicingDunningCase(draft, action) {
+            delete draft.dunningCaseByID[action.payload];
+        },
+        clearAllInvoicingDunningCases(draft) {
+            Object.assign(draft, exports.initialState);
+        },
+    },
+});
+_a = dunningCase.actions, exports.updateInvoicingDunningCases = _a.updateInvoicingDunningCases, exports.removeInvoicingDunningCase = _a.removeInvoicingDunningCase, exports.clearAllInvoicingDunningCases = _a.clearAllInvoicingDunningCases;
+exports.default = dunningCase.reducer;
+/**
+ * Helper functions.
+ */
+function doUpdateInvoicingDunningCases(draft, payload, updateType) {
+    payload.forEach((dunningCasePayload) => {
+        const latestDunningCase = (0, dunningCasePayload_1.mapInvoicingDunningCasePayloadToState)(dunningCasePayload);
+        if (latestDunningCase.id in draft && updateType === 'merge') {
+            (0, assignWith_1.default)(draft[latestDunningCase.id], latestDunningCase, (objValue, srcValue) => (srcValue == null ? objValue : srcValue));
+        }
+        else {
+            draft[latestDunningCase.id] = latestDunningCase;
+        }
+    });
+}

package/lib/entity/invoicing/dunningCase/dunningCaseSelector.d.ts

@@ -0,0 +1,4 @@
+import { ID } from '../../../commonStateTypes/common';
+import { InvoicingDunningCase, InvoicingDunningCaseState } from './dunningCaseState';
+export declare function getInvoicingDunningCasesByIds(dunningCaseState: InvoicingDunningCaseState, ids: ID[]): InvoicingDunningCase[];
+export declare function getInvoicingDunningCaseById(dunningCaseState: InvoicingDunningCaseState, id: ID): InvoicingDunningCase | undefined;

package/lib/entity/invoicing/dunningCase/dunningCaseSelector.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInvoicingDunningCasesByIds = getInvoicingDunningCasesByIds;
+exports.getInvoicingDunningCaseById = getInvoicingDunningCaseById;
+const get_1 = __importDefault(require("lodash/get"));
+function getInvoicingDunningCasesByIds(dunningCaseState, ids) {
+    const dunningCases = ids
+        .map((id) => getInvoicingDunningCaseById(dunningCaseState, id))
+        .filter((value) => value != null);
+    return dunningCases;
+}
+function getInvoicingDunningCaseById(dunningCaseState, id) {
+    return (0, get_1.default)(dunningCaseState.dunningCaseByID, id);
+}