49 lines
1.4 KiB
TypeScript
49 lines
1.4 KiB
TypeScript
import { InternalError } from "@api/errors";
|
|
import type { LineItemContext } from "@models/billingModels/lineItem/lineItemContext";
|
|
import { featureUsageToDescription } from "@utils/billingUtils/invoicingUtils/descriptionUtils/featureUsageToDescription";
|
|
import { lineItemToPeriodDescription } from "@utils/billingUtils/invoicingUtils/descriptionUtils/lineItemToPeriodDescription";
|
|
import { isOneOffPrice } from "@utils/productUtils/priceUtils/classifyPriceUtils";
|
|
|
|
export const usagePriceToLineDescription = ({
|
|
usage,
|
|
context,
|
|
includePeriodDescription = true,
|
|
}: {
|
|
usage: number;
|
|
context: LineItemContext;
|
|
includePeriodDescription?: boolean;
|
|
}): string => {
|
|
const { price, feature } = context;
|
|
const billingUnits = price.config.billing_units ?? 1;
|
|
|
|
if (!feature) {
|
|
throw new InternalError({
|
|
message: `[usagePriceToLineDescription] No feature found for line item context`,
|
|
});
|
|
}
|
|
|
|
// 1. Get feature usage description (eg. "3 x 150 credits")
|
|
const featureUsageDescription = featureUsageToDescription({
|
|
feature,
|
|
usage,
|
|
billingUnits,
|
|
});
|
|
|
|
const { product } = context;
|
|
let description = `${product.name} - ${featureUsageDescription}`;
|
|
|
|
if (!isOneOffPrice(price) && includePeriodDescription) {
|
|
const periodDescription = lineItemToPeriodDescription({
|
|
context,
|
|
});
|
|
|
|
description = `${description} (${periodDescription})`;
|
|
}
|
|
|
|
if (context.direction === "refund") {
|
|
description = `Unused ${description}`;
|
|
}
|
|
|
|
return description;
|
|
};
|