@aptos-scp/scp-component-store-selling-features-domain-model 2.47.0 → 2.48.1

package/lib/domain/UIBusinessEventTypes.js

@@ -53,7 +53,7 @@ exports.ITEM_TAX_OVERRIDE_EVENT = "ItemTaxOverride";
 exports.SELL_ITEM_NOT_ON_FILE_EVENT = "SellItemNotOnFile";
 exports.ORDER_ITEM_NOT_ON_FILE_EVENT = "OrderItemNotOnFile";
 exports.ORDER_ITEM_CANCELLATION_EVENT = "OrderItemCancellation";
-exports.FINALIZE_ORDER_ITEM_CANCELLATION_EVENT = "FinalizeOrderItemCancellation";
+exports.FINALIZE_ORDER_ITEM_CANCELLATION_EVENT = "FinalizeOrderItemCancellation"; //Deprecated
 exports.ORDER_ITEM_RESTORE_EVENT = "OrderItemRestore";
 exports.RESERVED_ORDER_ITEM_CANCELLATION_EVENT = "ReservedOrderItemCancellation";
 exports.ORDER_ITEM_PICKUP_EVENT = "OrderItemPickup";

package/lib/domain/model/Constants.d.ts

@@ -333,6 +333,10 @@ export declare enum UiInputKey {
     MAPPED_REFUND_TENDER_TYPE_NAME = "input_mappedRefundTenderTypeName",
     MAPPED_REFUND_CARD_TYPE_NAME = "input_mappedRefundCardTypeName",
     PRE_AUTH = "input_preAuth",
+    /**
+     * When true, APPLY_TENDER (routed to refund) is reversing tender held as authorization only (e.g. order cancel).
+     */
+    PRE_AUTHORIZATION_REVERSAL = "input_preAuthorizationReversal",
     EXCLUDED_REFUND_CARD_TYPE_NAMES = "input_excludedRefundCardTypeNames",
     TRANSACTION_NUMBER_FIELD = "input_transactionNumberField",
     TRANSACTION_REFERENCE_NUMBER_FIELD = "input_referenceNumberField",
@@ -986,6 +990,11 @@ export declare enum CollectedDataKey {
     PrepaidTaxAmount = "prepaidTaxAmount",
     PrepaidSavingsAmount = "prepaidSavingsAmount",
     PreviouslyCollectedTender = "previouslyCollectedTender",
+    /**
+     * When ToBeStarted (or legacy boolean true) as collected data with TenderAuthResponse,
+     * merges IAuthorizationResponse.preAuthorizationReversalStatus.
+     */
+    PreAuthorizationReversal = "PreAuthorizationReversal",
     PresetRateExemption = "presetRateExemption",
     PresetExemptionCategory = "presetExemptionCategory",
     PresetExemptionRate = "presetExemptionRate",

package/lib/domain/model/Constants.js

@@ -334,6 +334,10 @@ var UiInputKey;
     UiInputKey["MAPPED_REFUND_TENDER_TYPE_NAME"] = "input_mappedRefundTenderTypeName";
     UiInputKey["MAPPED_REFUND_CARD_TYPE_NAME"] = "input_mappedRefundCardTypeName";
     UiInputKey["PRE_AUTH"] = "input_preAuth";
+    /**
+     * When true, APPLY_TENDER (routed to refund) is reversing tender held as authorization only (e.g. order cancel).
+     */
+    UiInputKey["PRE_AUTHORIZATION_REVERSAL"] = "input_preAuthorizationReversal";
     UiInputKey["EXCLUDED_REFUND_CARD_TYPE_NAMES"] = "input_excludedRefundCardTypeNames";
     UiInputKey["TRANSACTION_NUMBER_FIELD"] = "input_transactionNumberField";
     UiInputKey["TRANSACTION_REFERENCE_NUMBER_FIELD"] = "input_referenceNumberField";
@@ -993,6 +997,11 @@ var CollectedDataKey;
     CollectedDataKey["PrepaidTaxAmount"] = "prepaidTaxAmount";
     CollectedDataKey["PrepaidSavingsAmount"] = "prepaidSavingsAmount";
     CollectedDataKey["PreviouslyCollectedTender"] = "previouslyCollectedTender";
+    /**
+     * When ToBeStarted (or legacy boolean true) as collected data with TenderAuthResponse,
+     * merges IAuthorizationResponse.preAuthorizationReversalStatus.
+     */
+    CollectedDataKey["PreAuthorizationReversal"] = "PreAuthorizationReversal";
     CollectedDataKey["PresetRateExemption"] = "presetRateExemption";
     CollectedDataKey["PresetExemptionCategory"] = "presetExemptionCategory";
     CollectedDataKey["PresetExemptionRate"] = "presetExemptionRate";

package/lib/domain/model/TenderType.js

@@ -352,10 +352,13 @@ class TenderType {
         return tenderType;
     }
     signatureRequired(tenderAmount, authResponse) {
-        var _a;
+        var _a, _b;
         let sigRequired = false;
+        if (((_a = authResponse) === null || _a === void 0 ? void 0 : _a.preAuthorizationReversalStatus) != null) {
+            return false;
+        }
         //if the auth type is updateAuthorization then use signatureCapturePolicyForCallForAuth
-        const signatureCapturePolicy = ((_a = authResponse) === null || _a === void 0 ? void 0 : _a.requestType) === scp_types_commerce_devices_1.PaymentRequestType.UpdateAuthorization
+        const signatureCapturePolicy = ((_b = authResponse) === null || _b === void 0 ? void 0 : _b.requestType) === scp_types_commerce_devices_1.PaymentRequestType.UpdateAuthorization
             ? this.signatureCapturePolicyForCallForAuth
             : this.signatureCapturePolicy;
         switch (signatureCapturePolicy) {

package/lib/domain/model/discounts/RewardCardDiscountLineTotalDecorator.d.ts

@@ -7,10 +7,9 @@ import { IManualDiscountLine } from "./IManualDiscountLine";
 import { ManualDiscountLineTotalDecorator } from "./ManualDiscountLineTotalDecorator";
 import { IRewardCardDiscountLine } from "./IRewardCardDiscountLine";
 export declare const DECORATOR_TYPE_REWARD_CARD_DISCOUNT_TOTAL: string;
-export declare const REWARD_CARD_TOTAL_DISCOUNT_ANNOTATION_SOURCE: string;
 export declare class RewardCardDiscountLineTotalDecorator extends ManualDiscountLineTotalDecorator implements IRewardCardDiscountLine {
     static createFromJsonObject(transactionLineJsonObj: any, transactionLineFactory: ITransactionLineFactory): RewardCardDiscountLineTotalDecorator;
-    constructor(decoratorLineType: string, decoratedTransactionLine: IManualDiscountLine, totalDiscount: Money, annotationSourceLineNumber?: number);
+    constructor(decoratorLineType: string, decoratedTransactionLine: IManualDiscountLine, totalDiscount: Money, annotationSourceType: string, annotationSourceLineNumber?: number);
     get discountLevel(): ManualDiscountLevel;
     get rewardPrintedName(): string;
     get rewardPrintedNumberLabel(): string;

package/lib/domain/model/discounts/RewardCardDiscountLineTotalDecorator.js

@@ -3,18 +3,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const scp_component_business_core_1 = require("@aptos-scp/scp-component-business-core");
 const ManualDiscountLineTotalDecorator_1 = require("./ManualDiscountLineTotalDecorator");
 exports.DECORATOR_TYPE_REWARD_CARD_DISCOUNT_TOTAL = "DECORATOR_TYPE_REWARD_CARD_DISCOUNT_TOTAL";
-exports.REWARD_CARD_TOTAL_DISCOUNT_ANNOTATION_SOURCE = "REWARD_CARD_TOTAL_DISCOUNT_ANNOTATION_SOURCE";
 class RewardCardDiscountLineTotalDecorator extends ManualDiscountLineTotalDecorator_1.ManualDiscountLineTotalDecorator {
     static createFromJsonObject(transactionLineJsonObj, transactionLineFactory) {
         const decoratedTransactionLineJsonObj = this.getDecoratedTransactionLineJsonObjectFromJsonObject(transactionLineJsonObj);
         const decoratedLine = transactionLineFactory.createTransactionLineFromJsonObj(decoratedTransactionLineJsonObj);
         const totalDiscount = scp_component_business_core_1.Money.fromJSON(transactionLineJsonObj._totalDiscount);
+        const annotationSourceType = this.getAnnotationSourceTypeFromJsonObject(transactionLineJsonObj);
         const annotationSourceLineNumber = this.getAnnotationSourceLineNumberFromJsonObject(transactionLineJsonObj);
         const decoratorType = this.getLineDecoratorTypeFromJsonObject(transactionLineJsonObj);
-        return new RewardCardDiscountLineTotalDecorator(decoratorType, decoratedLine, totalDiscount, annotationSourceLineNumber);
+        return new RewardCardDiscountLineTotalDecorator(decoratorType, decoratedLine, totalDiscount, annotationSourceType, annotationSourceLineNumber);
     }
-    constructor(decoratorLineType, decoratedTransactionLine, totalDiscount, annotationSourceLineNumber) {
-        super(decoratorLineType, decoratedTransactionLine, undefined, exports.REWARD_CARD_TOTAL_DISCOUNT_ANNOTATION_SOURCE, totalDiscount, annotationSourceLineNumber);
+    constructor(decoratorLineType, decoratedTransactionLine, totalDiscount, annotationSourceType, annotationSourceLineNumber) {
+        super(decoratorLineType, decoratedTransactionLine, undefined, annotationSourceType, totalDiscount, annotationSourceLineNumber);
     }
     get discountLevel() {
         return this.decoratedTransactionLine.discountLevel;
@@ -59,7 +59,7 @@ class RewardCardDiscountLineTotalDecorator extends ManualDiscountLineTotalDecora
         return this.decoratedTransactionLine.inputSource;
     }
     newTransactionLine() {
-        return new RewardCardDiscountLineTotalDecorator(this.lineDecoratorType, this.decoratedTransactionLine, this.totalDiscount, this.annotationSourceLineNumber);
+        return new RewardCardDiscountLineTotalDecorator(this.lineDecoratorType, this.decoratedTransactionLine, this.totalDiscount, this.annotationSourceType, this.annotationSourceLineNumber);
     }
 }
 exports.RewardCardDiscountLineTotalDecorator = RewardCardDiscountLineTotalDecorator;

package/lib/domain/model/tender/BaseTenderLineDecorator.d.ts

@@ -27,6 +27,7 @@ export declare abstract class BaseTenderLineDecorator extends BaseLineDecorator<
     get transactionLineReference(): ITransactionLineReferenceType;
     get refundedLineReference(): ITransactionLineReferenceType;
     get originalTenderReferences(): IOriginalTenderReference[];
+    get isPreAuthorizationReversal(): boolean;
     get refunded(): boolean;
     signatureRequired(): boolean;
     printDeclineDetails(): boolean;

package/lib/domain/model/tender/BaseTenderLineDecorator.js

@@ -51,6 +51,9 @@ class BaseTenderLineDecorator extends BaseLineDecorator_1.BaseLineDecorator {
     get originalTenderReferences() {
         return this.decoratedTransactionLine.originalTenderReferences;
     }
+    get isPreAuthorizationReversal() {
+        return this.decoratedTransactionLine.isPreAuthorizationReversal;
+    }
     get refunded() {
         return this.decoratedTransactionLine.refunded;
     }

package/lib/domain/model/tender/ITenderLine.d.ts

@@ -26,6 +26,8 @@ export interface ITenderLine extends ITransactionLine, IVoidableLine {
     readonly adjustmentType?: TenderAdjustmentType;
     readonly originalTenderReferences?: IOriginalTenderReference[];
     readonly actionType?: ActionType;
+    /** True when this TenderRefund reverses an authorization-only hold (see IAuthorizationResponse.preAuthorizationReversalStatus). */
+    readonly isPreAuthorizationReversal?: boolean;
     readonly tax?: Money;
     /**
      * The amount given before the conversion

package/lib/domain/model/tender/RewardCardTenderAppliedAmountDecorator.d.ts

@@ -4,11 +4,10 @@ import { BaseLineDecorator } from "../BaseLineDecorator";
 import { VoidSource } from "../Constants";
 import { RewardCardTenderLine } from "./RewardCardTenderLine";
 export declare const DECORATOR_TYPE_REWARD_CARD_TENDER_APPLIED_AMOUNT: string;
-export declare const REWARD_CARD_TENDER_APPLIED_AMOUNT_ANNOTATION_SOURCE: string;
 export declare class RewardCardTenderAppliedAmountDecorator extends BaseLineDecorator<RewardCardTenderLine> {
     private _appliedAmount;
     static createFromJsonObject(transactionLineJsonObj: any, transactionLineFactory: ITransactionLineFactory): RewardCardTenderAppliedAmountDecorator;
-    constructor(decoratorLineType: string, decoratedTransactionLine: RewardCardTenderLine, appliedAmount: Money, annotationSourceLineNumber?: number);
+    constructor(decoratorLineType: string, decoratedTransactionLine: RewardCardTenderLine, appliedAmount: Money, annotationSourceType: string, annotationSourceLineNumber?: number);
     get appliedAmount(): Money;
     get cardNumber(): string;
     get customerNumber(): string;

package/lib/domain/model/tender/RewardCardTenderAppliedAmountDecorator.js

@@ -3,19 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const scp_component_business_core_1 = require("@aptos-scp/scp-component-business-core");
 const BaseLineDecorator_1 = require("../BaseLineDecorator");
 exports.DECORATOR_TYPE_REWARD_CARD_TENDER_APPLIED_AMOUNT = "DECORATOR_TYPE_REWARD_CARD_TENDER_APPLIED_AMOUNT";
-exports.REWARD_CARD_TENDER_APPLIED_AMOUNT_ANNOTATION_SOURCE = "REWARD_CARD_TENDER_APPLIED_AMOUNT_ANNOTATION_SOURCE";
 class RewardCardTenderAppliedAmountDecorator extends BaseLineDecorator_1.BaseLineDecorator {
-    constructor(decoratorLineType, decoratedTransactionLine, appliedAmount, annotationSourceLineNumber) {
-        super(decoratorLineType, decoratedTransactionLine, exports.REWARD_CARD_TENDER_APPLIED_AMOUNT_ANNOTATION_SOURCE, exports.REWARD_CARD_TENDER_APPLIED_AMOUNT_ANNOTATION_SOURCE, annotationSourceLineNumber);
+    constructor(decoratorLineType, decoratedTransactionLine, appliedAmount, annotationSourceType, annotationSourceLineNumber) {
+        super(decoratorLineType, decoratedTransactionLine, undefined, annotationSourceType, annotationSourceLineNumber);
         this._appliedAmount = appliedAmount;
     }
     static createFromJsonObject(transactionLineJsonObj, transactionLineFactory) {
         const decoratedTransactionLineJsonObj = BaseLineDecorator_1.BaseLineDecorator.getDecoratedTransactionLineJsonObjectFromJsonObject(transactionLineJsonObj);
         const decoratedLine = transactionLineFactory.createTransactionLineFromJsonObj(decoratedTransactionLineJsonObj);
         const appliedAmount = scp_component_business_core_1.Money.fromJSON(transactionLineJsonObj._appliedAmount);
+        const annotationSourceType = BaseLineDecorator_1.BaseLineDecorator.getAnnotationSourceTypeFromJsonObject(transactionLineJsonObj);
         const annotationSourceLineNumber = BaseLineDecorator_1.BaseLineDecorator.getAnnotationSourceLineNumberFromJsonObject(transactionLineJsonObj);
         const decoratorType = BaseLineDecorator_1.BaseLineDecorator.getLineDecoratorTypeFromJsonObject(transactionLineJsonObj);
-        return new RewardCardTenderAppliedAmountDecorator(decoratorType, decoratedLine, appliedAmount, annotationSourceLineNumber);
+        return new RewardCardTenderAppliedAmountDecorator(decoratorType, decoratedLine, appliedAmount, annotationSourceType, annotationSourceLineNumber);
     }
     get appliedAmount() {
         return this._appliedAmount;
@@ -51,7 +51,7 @@ class RewardCardTenderAppliedAmountDecorator extends BaseLineDecorator_1.BaseLin
         return this.decoratedTransactionLine.isAuthorized;
     }
     newTransactionLine() {
-        return new RewardCardTenderAppliedAmountDecorator(this.lineDecoratorType, this.decoratedTransactionLine, this._appliedAmount, this.annotationSourceLineNumber);
+        return new RewardCardTenderAppliedAmountDecorator(this.lineDecoratorType, this.decoratedTransactionLine, this._appliedAmount, this.annotationSourceType, this.annotationSourceLineNumber);
     }
 }
 exports.RewardCardTenderAppliedAmountDecorator = RewardCardTenderAppliedAmountDecorator;

package/lib/domain/model/tender/TenderLine.d.ts

@@ -78,6 +78,10 @@ export declare class TenderLine extends BaseTransactionLine implements ITenderLi
     get preventsTransactionVoid(): boolean;
     get forfeitTenderChangeConfirmed(): boolean;
     get isPreviouslyCollected(): boolean;
+    /**
+     * True when this TenderRefund line reverses a tender that was only pre-authorized (authorization reversal).
+     */
+    get isPreAuthorizationReversal(): boolean;
     get allowVoid(): boolean;
     get adjustmentType(): TenderAdjustmentType;
     get voidingLine(): boolean;

package/lib/domain/model/tender/TenderLine.js

@@ -61,7 +61,19 @@ class TenderLine extends BaseTransactionLine_1.BaseTransactionLine {
         // The tender could (in the future) be a foreign tender with a currency other than the accounting currency.
         const accountingCurrency = collectedData.get("accountingCurrency");
         const extendedAmount = TenderLine.determineExtendedAmount(lineType, tenderAmount, accountingCurrency);
-        const authResponse = collectedData.get(Constants_1.CollectedDataKey.TenderAuthResponse);
+        // Auth payload from qualification (e.g. device response). When PreAuthorizationReversal is collected
+        // (order-cancel apply of OMS pre-auth), copy and stamp preAuthorizationReversalStatus so posting/display
+        // treat the line as a reversal; default requestType to Refund if none was supplied.
+        let mergedAuthResponse = collectedData.get(Constants_1.CollectedDataKey.TenderAuthResponse);
+        const rawPreAuthReversal = collectedData.get(Constants_1.CollectedDataKey.PreAuthorizationReversal);
+        const preAuthorizationReversalCollected = rawPreAuthReversal === true || rawPreAuthReversal === scp_types_commerce_devices_1.PreAuthorizationReversalStatus.ToBeStarted;
+        if (preAuthorizationReversalCollected) {
+            mergedAuthResponse = Object.assign({}, (mergedAuthResponse || {}));
+            mergedAuthResponse.preAuthorizationReversalStatus = scp_types_commerce_devices_1.PreAuthorizationReversalStatus.ToBeStarted;
+            if (mergedAuthResponse.requestType === undefined) {
+                mergedAuthResponse.requestType = scp_types_commerce_devices_1.PaymentRequestType.Refund;
+            }
+        }
         const authorizationDeviceId = collectedData.get(Constants_1.CollectedDataKey.AuthorizationDeviceId);
         const preventsTransactionVoid = !!collectedData.get(Constants_1.CollectedDataKey.TenderPreventsTransactionVoid);
         const adjustmentType = collectedData.get(Constants_1.CollectedDataKey.TenderAdjustmentType);
@@ -81,7 +93,7 @@ class TenderLine extends BaseTransactionLine_1.BaseTransactionLine {
         const previouslyCollectedTender = collectedData.get(Constants_1.CollectedDataKey.PreviouslyCollectedTender)
             ? collectedData.get(Constants_1.CollectedDataKey.PreviouslyCollectedTender)
             : false;
-        return new TenderLine(lineNumber, lineType, extendedAmount, tenderAuthCategory, tenderType, tenderAmount, authResponse, authorizationDeviceId, preventsTransactionVoid, adjustmentType, transactionLineReference, refundedLineReference, referenceNumber, residentLimit, promptRuleType, originalTenderReferences, actionType, supervisorOverrideLineReference, tax, foreignTenderAmount, exchangeRateValue, exchangeRateManualEntryLineReference, forfeitTenderChangeConfirmed, previouslyCollectedTender);
+        return new TenderLine(lineNumber, lineType, extendedAmount, tenderAuthCategory, tenderType, tenderAmount, mergedAuthResponse, authorizationDeviceId, preventsTransactionVoid, adjustmentType, transactionLineReference, refundedLineReference, referenceNumber, residentLimit, promptRuleType, originalTenderReferences, actionType, supervisorOverrideLineReference, tax, foreignTenderAmount, exchangeRateValue, exchangeRateManualEntryLineReference, forfeitTenderChangeConfirmed, previouslyCollectedTender);
     }
     static createFromJsonObject(transactionLineJsonObj) {
         const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
@@ -210,12 +222,20 @@ class TenderLine extends BaseTransactionLine_1.BaseTransactionLine {
     get isPreviouslyCollected() {
         return this._previouslyCollectedTender;
     }
+    /**
+     * True when this TenderRefund line reverses a tender that was only pre-authorized (authorization reversal).
+     */
+    get isPreAuthorizationReversal() {
+        var _a;
+        return ((_a = this._authResponse) === null || _a === void 0 ? void 0 : _a.preAuthorizationReversalStatus) != null;
+    }
     get allowVoid() {
         var _a;
         if (this.authResponse &&
-            this.authResponse.paymentProvider === scp_types_commerce_devices_1.PaymentProvider.Adyen &&
             this.lineType === exports.TENDER_REFUND_LINE_TYPE &&
-            ((_a = this.tenderType) === null || _a === void 0 ? void 0 : _a.cardType) !== scp_types_commerce_devices_1.CardType.Gift) {
+            ((this.authResponse.paymentProvider === scp_types_commerce_devices_1.PaymentProvider.Adyen &&
+                ((_a = this.tenderType) === null || _a === void 0 ? void 0 : _a.cardType) !== scp_types_commerce_devices_1.CardType.Gift) ||
+                this.authResponse.preAuthorizationReversalStatus != null)) {
             //a payment provider was used for a refund that can't be voided, so don't allow voiding
             return false;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptos-scp/scp-component-store-selling-features-domain-model",
-  "version": "2.47.0",
+  "version": "2.48.1",
   "description": "This component library provides the common components to handle the coordination of processing the business events from the UI.",
   "private": false,
   "license": "SEE LICENSE IN LICENSE.md",
@@ -85,8 +85,8 @@
     "@aptos-scp/scp-component-taxation": "^5.28.0",
     "@aptos-scp/scp-component-user": "^1.4.0",
     "@aptos-scp/scp-types-client-registration": "^1.4.0",
-    "@aptos-scp/scp-types-commerce-devices": "^6.10.0",
-    "@aptos-scp/scp-types-commerce-transaction": "^1.93.0",
+    "@aptos-scp/scp-types-commerce-devices": "^6.12.0",
+    "@aptos-scp/scp-types-commerce-transaction": "^1.94.0",
     "@aptos-scp/scp-types-core": "^1.0.5",
     "@aptos-scp/scp-types-core-config": "^2.2.1",
     "@aptos-scp/scp-types-currency-conversion": "^1.2.0",