@zeniai/client-epic-state 5.2.80 → 5.2.82

package/lib/esm/view/expenseAutomationView/helpers/transactionCategorizationLocalDataHelper.js

@@ -1,3 +1,4 @@
+import { isCustomerTransaction, } from '../../../entity/transaction/stateTypes/customerTransaction';
 import { isVendorTransaction } from '../../../entity/transaction/stateTypes/vendorTransaction';
 import { isEntityMatching, mergeTransactionAndEntityRecommendationsWithCOT, toLineEntity, } from '../../transactionDetail/transactionDetailLocalDataHelper';
 import { isAccountUncategorized } from '../../transactionDetail/transactionDetailLocalDataHelper';
@@ -208,7 +209,10 @@ const buildLineItemById = (transaction, recommendations) => {
                         logo: accountLine.vendor.logo,
                     }
                     : undefined;
-            const customer = accountLine.customer;
+            const customer = accountLine.customer ??
+                (isCustomerTransaction(transaction) === true
+                    ? transaction.customer
+                    : undefined);
             record.customer =
                 customer != null && Boolean(customer.id) && Boolean(customer.name)
                     ? {

package/lib/esm/view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewPayload.js

@@ -59,11 +59,59 @@ export const localDataToSaveInvoicingSubscriptionPayload = (localData, shippingA
     };
 };
 const toEstimateDate = (value) => value != null && value !== '' ? date(value) : undefined;
+const isItemLevelCoupon = (discount) => discount.entity_type === 'item_level_coupon';
+const isCoupon = (discount) => discount.entity_type === 'document_level_coupon' ||
+    discount.entity_type === 'item_level_coupon';
+/**
+ * Name the coupon behind a line's discount. Exact when the API links a coupon
+ * row to its line (`line_item_id`); otherwise only when a single item-level
+ * coupon applies, since then every discounted line got that one.
+ */
+const lineDiscountLabel = (lineItem, discounts) => {
+    if (lineItem.discount_amount <= 0) {
+        return undefined;
+    }
+    const itemCoupons = discounts.filter(isItemLevelCoupon);
+    const linked = lineItem.id != null
+        ? itemCoupons.filter((coupon) => coupon.line_item_id === lineItem.id)
+        : [];
+    if (linked.length > 0) {
+        return [...new Set(linked.map((coupon) => coupon.description))].join(', ');
+    }
+    const names = [...new Set(itemCoupons.map((coupon) => coupon.description))];
+    return names.length === 1 ? names[0] : undefined;
+};
+/**
+ * One row per coupon. An item-level coupon comes back once per line it
+ * discounted, so its rows are summed; listing each would read as the same
+ * discount taken several times.
+ */
+const mergeCouponRows = (discounts) => {
+    const rowsByCoupon = new Map();
+    discounts.filter(isCoupon).forEach((coupon) => {
+        // The API sends `entity_id: ""` when it has none; key those by name so
+        // two unrelated coupons are not merged into one row.
+        const couponKey = coupon.entity_id != null && coupon.entity_id !== ''
+            ? coupon.entity_id
+            : coupon.description;
+        const key = `${coupon.entity_type}:${couponKey}`;
+        const row = rowsByCoupon.get(key);
+        rowsByCoupon.set(key, {
+            amount: Math.round(((row?.amount ?? 0) + coupon.amount) * 100) / 100,
+            description: coupon.description,
+        });
+    });
+    return [...rowsByCoupon.values()];
+};
 const mapInvoiceEstimate = (payload, money) => payload == null
     ? undefined
     : {
         amountDue: money(payload.amount_due),
         couponDiscountTotal: money(payload.coupon_discount_total),
+        coupons: mergeCouponRows(payload.discounts ?? []).map((coupon) => ({
+            amount: money(coupon.amount),
+            description: coupon.description,
+        })),
         creditsApplied: money(payload.credits_applied),
         dueDate: toEstimateDate(payload.due_date),
         grossSubTotal: money(payload.gross_sub_total),
@@ -74,6 +122,8 @@ const mapInvoiceEstimate = (payload, money) => payload == null
             dateTo: toEstimateDate(lineItem.date_to),
             description: lineItem.description,
             discountAmount: money(lineItem.discount_amount),
+            discountLabel: lineDiscountLabel(lineItem, payload.discounts ?? []),
+            grossAmount: money(lineItem.gross_amount ?? lineItem.amount),
             quantity: lineItem.quantity,
             taxAmount: lineItem.tax_amount != null
                 ? money(lineItem.tax_amount)

package/lib/index.d.ts

@@ -1128,7 +1128,7 @@ export { getInvoicingCustomerFormView } from './view/invoicing/editInvoicingCust
 export type { InvoicingCustomerFormView } from './view/invoicing/editInvoicingCustomerDetailView/editInvoicingCustomerDetailViewSelector';
 export { clearInvoicingSubscriptionEstimate, fetchInvoicingSubscriptionEstimate, fetchInvoicingSubscriptionFormPage, initializeInvoicingSubscriptionAddress, resetEditInvoicingSubscriptionDetailView, submitInvoicingSubscriptionForm, updateInvoicingSubscriptionFormDraft, } from './view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewReducer';
 export type { SubmitInvoicingSubscriptionFormPayload, UpdateInvoicingSubscriptionFormDraftPayload, } from './view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewReducer';
-export type { InvoicingSubscriptionEstimateLineItem, InvoicingSubscriptionFormLocalData, InvoicingSubscriptionInvoiceEstimate, } from './view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewState';
+export type { InvoicingSubscriptionEstimateCoupon, InvoicingSubscriptionEstimateLineItem, InvoicingSubscriptionFormLocalData, InvoicingSubscriptionInvoiceEstimate, } from './view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewState';
 export { INVOICING_SUBSCRIPTION_SHIPPING_ADDRESS_TYPE, entityToInvoicingSubscriptionFormLocalData, initialInvoicingSubscriptionFormLocalData, invoicingSubscriptionTodayIso, toInvoicingSubscriptionQuantity, } from './view/invoicing/editInvoicingSubscriptionDetailView/invoicingSubscriptionFormConfig';
 export { getEditInvoicingSubscriptionDetailViewState, getInvoicingSubscriptionFormView, } from './view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewSelector';
 export type { EditInvoicingSubscriptionDetailView, InvoicingSubscriptionEstimateKind, InvoicingSubscriptionEstimateView, InvoicingSubscriptionFormView, InvoicingSubscriptionOption, } from './view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewSelector';

package/lib/view/expenseAutomationView/helpers/transactionCategorizationLocalDataHelper.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.hasTransactionLocalDataChanges = exports.isAnyItemWithUncategorizedExpenseAccount = exports.getSnackbarMessageForTransactionReview = exports.mergeTabSpecificLineItems = exports.getLineItemsByTransactionIdsFromLocalData = exports.getLineItemsByTransactionsIdsFromResponse = exports.checkIfAllLineItemsAreCategoryClassFilled = exports.setEntityRecommendationForLineIdInLocalData = exports.toSetAllLineItemsToCategoryClass = exports.toTransactionDetailLocalData = exports.shouldAutoSelectAndAdd = exports.MAX_SELECTION_LIMIT = exports.filterAutoTabLineItems = exports.removeTransactionFromTabView = exports.getPendingReviewLineIdsFromTransaction = void 0;
+const customerTransaction_1 = require("../../../entity/transaction/stateTypes/customerTransaction");
 const vendorTransaction_1 = require("../../../entity/transaction/stateTypes/vendorTransaction");
 const transactionDetailLocalDataHelper_1 = require("../../transactionDetail/transactionDetailLocalDataHelper");
 const transactionDetailLocalDataHelper_2 = require("../../transactionDetail/transactionDetailLocalDataHelper");
@@ -216,7 +217,10 @@ const buildLineItemById = (transaction, recommendations) => {
                         logo: accountLine.vendor.logo,
                     }
                     : undefined;
-            const customer = accountLine.customer;
+            const customer = accountLine.customer ??
+                ((0, customerTransaction_1.isCustomerTransaction)(transaction) === true
+                    ? transaction.customer
+                    : undefined);
             record.customer =
                 customer != null && Boolean(customer.id) && Boolean(customer.name)
                     ? {

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

@@ -82,8 +82,17 @@ interface InvoicingSubscriptionEstimateLineItemPayload {
     unit_amount: number;
     date_from?: string;
     date_to?: string;
+    gross_amount?: number;
+    id?: string;
     tax_amount?: number | null;
 }
+interface InvoicingSubscriptionEstimateDiscountPayload {
+    amount: number;
+    description: string;
+    entity_type: string;
+    entity_id?: string;
+    line_item_id?: string | null;
+}
 interface InvoicingSubscriptionInvoiceEstimatePayload {
     amount_due: number;
     coupon_discount_total: number;
@@ -94,6 +103,7 @@ interface InvoicingSubscriptionInvoiceEstimatePayload {
     sub_total: number;
     tax: number | null;
     total: number;
+    discounts?: InvoicingSubscriptionEstimateDiscountPayload[];
     due_date?: string;
     invoice_date?: string;
 }

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

@@ -63,11 +63,59 @@ const localDataToSaveInvoicingSubscriptionPayload = (localData, shippingAddress)
 };
 exports.localDataToSaveInvoicingSubscriptionPayload = localDataToSaveInvoicingSubscriptionPayload;
 const toEstimateDate = (value) => value != null && value !== '' ? (0, zeniDayJS_1.date)(value) : undefined;
+const isItemLevelCoupon = (discount) => discount.entity_type === 'item_level_coupon';
+const isCoupon = (discount) => discount.entity_type === 'document_level_coupon' ||
+    discount.entity_type === 'item_level_coupon';
+/**
+ * Name the coupon behind a line's discount. Exact when the API links a coupon
+ * row to its line (`line_item_id`); otherwise only when a single item-level
+ * coupon applies, since then every discounted line got that one.
+ */
+const lineDiscountLabel = (lineItem, discounts) => {
+    if (lineItem.discount_amount <= 0) {
+        return undefined;
+    }
+    const itemCoupons = discounts.filter(isItemLevelCoupon);
+    const linked = lineItem.id != null
+        ? itemCoupons.filter((coupon) => coupon.line_item_id === lineItem.id)
+        : [];
+    if (linked.length > 0) {
+        return [...new Set(linked.map((coupon) => coupon.description))].join(', ');
+    }
+    const names = [...new Set(itemCoupons.map((coupon) => coupon.description))];
+    return names.length === 1 ? names[0] : undefined;
+};
+/**
+ * One row per coupon. An item-level coupon comes back once per line it
+ * discounted, so its rows are summed; listing each would read as the same
+ * discount taken several times.
+ */
+const mergeCouponRows = (discounts) => {
+    const rowsByCoupon = new Map();
+    discounts.filter(isCoupon).forEach((coupon) => {
+        // The API sends `entity_id: ""` when it has none; key those by name so
+        // two unrelated coupons are not merged into one row.
+        const couponKey = coupon.entity_id != null && coupon.entity_id !== ''
+            ? coupon.entity_id
+            : coupon.description;
+        const key = `${coupon.entity_type}:${couponKey}`;
+        const row = rowsByCoupon.get(key);
+        rowsByCoupon.set(key, {
+            amount: Math.round(((row?.amount ?? 0) + coupon.amount) * 100) / 100,
+            description: coupon.description,
+        });
+    });
+    return [...rowsByCoupon.values()];
+};
 const mapInvoiceEstimate = (payload, money) => payload == null
     ? undefined
     : {
         amountDue: money(payload.amount_due),
         couponDiscountTotal: money(payload.coupon_discount_total),
+        coupons: mergeCouponRows(payload.discounts ?? []).map((coupon) => ({
+            amount: money(coupon.amount),
+            description: coupon.description,
+        })),
         creditsApplied: money(payload.credits_applied),
         dueDate: toEstimateDate(payload.due_date),
         grossSubTotal: money(payload.gross_sub_total),
@@ -78,6 +126,8 @@ const mapInvoiceEstimate = (payload, money) => payload == null
             dateTo: toEstimateDate(lineItem.date_to),
             description: lineItem.description,
             discountAmount: money(lineItem.discount_amount),
+            discountLabel: lineDiscountLabel(lineItem, payload.discounts ?? []),
+            grossAmount: money(lineItem.gross_amount ?? lineItem.amount),
             quantity: lineItem.quantity,
             taxAmount: lineItem.tax_amount != null
                 ? money(lineItem.tax_amount)

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

@@ -41,19 +41,32 @@ export interface InvoicingSubscriptionFormLocalData {
     setupFee?: Amount;
 }
 export interface InvoicingSubscriptionEstimateLineItem {
+    /** After the line's own (item-level) coupons. */
     amount: Amount;
     description: string;
+    /** Item-level coupons on this line; invoice-level coupons are not spread here. */
     discountAmount: Amount;
+    /** Before any coupon, so the lines add up to `grossSubTotal`. */
+    grossAmount: Amount;
     quantity: number;
     unitAmount: Amount;
     dateFrom?: ZeniDate;
     dateTo?: ZeniDate;
+    /** The coupon behind `discountAmount`, when it can be told; see the mapper. */
+    discountLabel?: string;
     taxAmount?: Amount;
 }
+/** A coupon the estimate applies, named, for the totals. */
+export interface InvoicingSubscriptionEstimateCoupon {
+    amount: Amount;
+    description: string;
+}
 /** An invoice the save would raise now, or the next one it would raise later. */
 export interface InvoicingSubscriptionInvoiceEstimate {
     amountDue: Amount;
     couponDiscountTotal: Amount;
+    /** Item- and invoice-level coupons, one row each; they sum to `couponDiscountTotal`. */
+    coupons: InvoicingSubscriptionEstimateCoupon[];
     /** Refundable credits plus excess payments; promotional credits are separate. */
     creditsApplied: Amount;
     grossSubTotal: Amount;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeniai/client-epic-state",
-  "version": "5.2.80",
+  "version": "5.2.82",
   "description": "Shared module between Web & Mobile containing required abstractions for state management, async network communication. ",
   "main": "lib/index.js",
   "module": "lib/esm/index.js",