@aptos-scp/scp-component-store-selling-features-domain-model 2.23.0 → 2.24.0-patch.2

package/lib/domain/utility/feeRefundUtils.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const scp_component_business_core_1 = require("@aptos-scp/scp-component-business-core");
+/**
+ * Known refund codes that identify legitimate fee refunds/credits.
+ * - SSARefund: Refunds generated through Store Selling App return flow
+ * - NonSSAShippingAppeasement: Shipping fee credits/appeasements from external OMS
+ */
+const KNOWN_REFUND_CODES = ["SSARefund", "NonSSAShippingAppeasement"];
+/**
+ * Checks if an AmountModifier represents a known refund/credit operation.
+ * Checks controlledOperation.reason.code first (more universal across OMS implementations),
+ * then falls back to amountModificationRule.name.
+ *
+ * @param modifier - The amount modifier to check
+ * @returns true if the modifier has a known refund code
+ */
+function isKnownRefundModifier(modifier) {
+    var _a, _b, _c;
+    // Primary: Check controlledOperation.reason.code (more universal across OMS implementations)
+    const reasonCode = (_b = (_a = modifier.controlledOperation) === null || _a === void 0 ? void 0 : _a.reason) === null || _b === void 0 ? void 0 : _b.code;
+    if (reasonCode && KNOWN_REFUND_CODES.includes(reasonCode)) {
+        return true;
+    }
+    // Fallback: Check amountModificationRule.name
+    const ruleName = (_c = modifier.amountModificationRule) === null || _c === void 0 ? void 0 : _c.name;
+    if (ruleName && KNOWN_REFUND_CODES.includes(ruleName)) {
+        return true;
+    }
+    return false;
+}
+/**
+ * Calculates the total amount previously refunded from a fee's amountModifiers.
+ * Only counts modifiers with "Subtract" action code AND a known refund code
+ * (SSARefund, NonSSAShippingAppeasement) to avoid counting other types of subtractions.
+ *
+ * @param amountModifiers - The array of amount modifiers from the order fee
+ * @param currency - The currency code for creating Money objects
+ * @returns The total previously refunded amount as a Money object
+ */
+function calculatePreviouslyRefundedAmount(amountModifiers, currency) {
+    if (!amountModifiers || amountModifiers.length === 0) {
+        return new scp_component_business_core_1.Money("0", currency);
+    }
+    return amountModifiers
+        .filter((modifier) => modifier.actionCode === "Subtract" && isKnownRefundModifier(modifier))
+        .reduce((total, modifier) => {
+        return total.plus(scp_component_business_core_1.Money.fromIMoney(modifier.amount));
+    }, new scp_component_business_core_1.Money("0", currency));
+}
+exports.calculatePreviouslyRefundedAmount = calculatePreviouslyRefundedAmount;
+/**
+ * Calculates the refundable amount remaining after subtracting previously refunded amounts.
+ *
+ * @param originalAmount - The original fee amount
+ * @param previouslyRefundedAmount - The amount already refunded
+ * @returns The remaining refundable amount as a Money object
+ */
+function calculateRefundableAmount(originalAmount, previouslyRefundedAmount) {
+    return originalAmount.minus(previouslyRefundedAmount);
+}
+exports.calculateRefundableAmount = calculateRefundableAmount;
+//# sourceMappingURL=feeRefundUtils.js.map

package/lib/domain/utility/index.d.ts

@@ -1,3 +1,5 @@
 export * from "./utils";
 export * from "./orderUtils";
+export * from "./orderFeeUtils";
 export * from "./itemImageUtils";
+export * from "./feeRefundUtils";

package/lib/domain/utility/index.js

@@ -5,5 +5,7 @@ function __export(m) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __export(require("./utils"));
 __export(require("./orderUtils"));
+__export(require("./orderFeeUtils"));
 __export(require("./itemImageUtils"));
+__export(require("./feeRefundUtils"));
 //# sourceMappingURL=index.js.map

package/lib/domain/utility/orderFeeUtils.d.ts

@@ -0,0 +1,58 @@
+import { IMoney, IPrice, Money, Price } from "@aptos-scp/scp-component-business-core";
+import { IConfigurationManager } from "@aptos-scp/scp-component-store-selling-core";
+import { FeeType, IFeeLine, IFeeSubline, IQuantity, ITaxByTaxAuthority, ITaxByTaxRule, ITaxOverride } from "@aptos-scp/scp-types-commerce-transaction";
+import { Approval as OrderApproval, Associate as OrderAssociate, ControlledOperation as OrderControlledOperation, Employee as OrderEmployee, ExtensibilityData as OrderExtensibilityData, ExtensibilityDataSet as OrderExtensibilityDataSet, Fee as OrderFee, MeasuredQuantity as OrderMeasuredQuantity, Operator as OrderOperator, PersonName as OrderPersonName, Reason as OrderReason, Tax as OrderTax, TaxCollection as OrderTaxCollection } from "@aptos-scp/scp-types-orders";
+import { IFeeDefinition, IShippingMethod } from "../model";
+/**
+ * Converts an order fee to a fee line.
+ * @param orderFee - The order fee to convert.
+ * @param configurationManager - The configuration manager for data enrichment when order fee doesn't support tracking certain fields.
+ * @returns The converted fee line.
+ */
+export declare function convertOrderFee(orderFee: OrderFee, orderReferenceId: string, configurationManager: IConfigurationManager): IFeeLine | undefined;
+export declare enum OrderFeeType {
+    Shipping = "Shipping",
+    Bag = "Bag",
+    Custom = "Custom",
+    RetailDelivery = "RetailDelivery",
+    PublicImprovement = "PublicImprovement",
+    HandlingFee = "HandlingFee",
+    WEEE = "WEEE",
+    EWaste = "EWaste",
+    BatteryFee = "BatteryFee",
+    FuelSurcharge = "FuelSurcharge",
+    EnvironmentalRecovery = "EnvironmentalRecovery",
+    Unknown = "Unknown"
+}
+export declare function convertFeeType(feeType: OrderFeeType): FeeType;
+export declare function getFeeTaxGroupIdFromConfig(orderFee: OrderFee, configurationManager: IConfigurationManager): string;
+export declare function getFeePercentFromConfig(orderFee: OrderFee, configurationManager: IConfigurationManager): number;
+export declare function convertFeeTaxes(taxCollection: OrderTaxCollection, taxableAmount: Money): ITaxByTaxAuthority[];
+export declare function convertTax(tax: OrderTax, taxableAmount?: Money): OrderTax;
+export declare function convertControlledOperation(controlledOperation: OrderControlledOperation): OrderControlledOperation;
+export declare function convertApproval(appproval: OrderApproval): OrderApproval;
+export declare function convertControlledOperationReason(reason: OrderReason): OrderReason;
+export declare function convertAssociate(associate: OrderAssociate): OrderAssociate;
+export declare function convertOperator(operator: OrderOperator): OrderOperator;
+export declare function convertToPersonName(personName: OrderPersonName): OrderPersonName;
+export declare function convertEmployee(employee: OrderEmployee): OrderEmployee;
+export declare function convertExtensibilityData(extensibilityData: OrderExtensibilityData): any;
+export declare function convertExtensibilityDataSet(extensibilityDataSet: OrderExtensibilityDataSet): OrderExtensibilityDataSet;
+export declare function convertTaxRules(taxByRules: OrderTax[]): ITaxByTaxRule[];
+export declare function convertTaxRule(tax: OrderTax): ITaxByTaxRule;
+export declare function convertFeeSublines(fee: OrderFee[]): IFeeSubline[];
+export declare function calculateFeeSublineExtendedAmounts(orderFee: OrderFee, extendedAmount: IMoney): {
+    extendedAmountExcludingTax: IMoney;
+    extendedAmountIncludingTax: IMoney;
+};
+export declare function convertShippingFeeTaxes(taxes: OrderTaxCollection): ITaxByTaxAuthority[];
+export declare function convertToPrice(money: Money, quantity?: number | string, units?: string): Price;
+export declare function convertFeeExtendedAmount(orderFee: OrderFee): IMoney;
+export declare function getItemTaxExemptAmount(taxes: OrderTax[]): IMoney | undefined;
+export declare function getItemTaxAdjustmentAmount(taxes: OrderTax[]): IMoney | undefined;
+export declare function convertQuantity(count: number, measure?: OrderMeasuredQuantity): IQuantity;
+export declare function getFeeDefinitionByFeeId(feeId: string, configurationManager: IConfigurationManager): IFeeDefinition | undefined;
+export declare function getShippingMethodConfigByFeeId(feeId: string, configurationManager: IConfigurationManager): IShippingMethod | undefined;
+export declare function convertTaxOverride(taxes: OrderTaxCollection, quantity?: number): ITaxOverride | undefined;
+export declare function convertPreTaxOverrideDetails(taxes: OrderTaxCollection): ITaxByTaxRule[];
+export declare function convertFeeUnitPrice(unitPrice: Price | IPrice): Price;