@aptos-scp/scp-component-store-selling-features-domain-model 2.17.0 → 2.18.0

package/lib/domain/UIBusinessEventTypes.d.ts

@@ -77,6 +77,8 @@ export declare const PERMANENT_MEMBERSHIP_DISCOUNT_EVENT: string;
 export declare const ADD_EMPLOYEE_CUSTOMER_EVENT: string;
 export declare const REWARD_CARD_DISCOUNT_EVENT: string;
 export declare const RESET_REWARD_CARD_BALANCE_INQUIRY_EVENT: string;
+export declare const APPLY_REWARD_CARD_EVENT: string;
+export declare const VOID_REWARD_CARD_EVENT: string;
 export declare const APPLY_EMPLOYEE_CUSTOMER_DISCOUNT_EVENT = "ApplyEmployeeCustomerDiscount";
 export declare const MODIFY_EMPLOYEE_MANUAL_DISCOUNT_EVENT: string;
 export declare const MODIFY_ITEM_MANUAL_DISCOUNT_EVENT: string;

package/lib/domain/UIBusinessEventTypes.js

@@ -80,6 +80,8 @@ exports.PERMANENT_MEMBERSHIP_DISCOUNT_EVENT = "PermanentMembershipDiscount";
 exports.ADD_EMPLOYEE_CUSTOMER_EVENT = "AddEmployeeCustomer";
 exports.REWARD_CARD_DISCOUNT_EVENT = "RewardCardDiscount";
 exports.RESET_REWARD_CARD_BALANCE_INQUIRY_EVENT = "ResetRewardCardBalanceInquiryDiscount";
+exports.APPLY_REWARD_CARD_EVENT = "ApplyRewardCard";
+exports.VOID_REWARD_CARD_EVENT = "VoidRewardCard";
 exports.APPLY_EMPLOYEE_CUSTOMER_DISCOUNT_EVENT = "ApplyEmployeeCustomerDiscount";
 exports.MODIFY_EMPLOYEE_MANUAL_DISCOUNT_EVENT = "ModifyEmployeeManualDiscount";
 exports.MODIFY_ITEM_MANUAL_DISCOUNT_EVENT = "ModifyItemManualDiscount";

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

@@ -0,0 +1,23 @@
+import { Money } from "@aptos-scp/scp-component-business-core";
+import { IAuthorizationResponse } from "@aptos-scp/scp-types-commerce-devices";
+import { ManualDiscountLevel } from "../configuration";
+import { TenderType } from "../TenderType";
+import { IManualDiscountLine } from "./IManualDiscountLine";
+export interface IRewardCardDiscountLine extends IManualDiscountLine {
+    readonly cardNumber: string;
+    readonly discountLevel: ManualDiscountLevel;
+    readonly rewardPrintedName: string;
+    readonly rewardPrintedNumberLabel: string;
+    readonly rewardCardName: string;
+    readonly autoPopulateCardNumberFromCustomer: boolean;
+    readonly pin: string;
+    /**
+     * The tenderId is the id of the tender associated with reward card authorization
+     */
+    readonly tenderId: string;
+    readonly authResponse: IAuthorizationResponse;
+    readonly tenderAmount: Money;
+    readonly tenderType: TenderType;
+    readonly authorizationDeviceId: string;
+    readonly isAuthorized: boolean;
+}

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

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IRewardCardDiscountLine.js.map

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

@@ -1,24 +1,24 @@
 import { Money, Price } from "@aptos-scp/scp-component-business-core";
 import { UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
 import { DiscountEntryType, ITransactionLineReferenceType, ManualDiscountType } from "@aptos-scp/scp-types-commerce-transaction";
-import { IAuthorizationResponse, TenderType } from "@aptos-scp/scp-types-commerce-devices";
+import { IAuthorizationResponse } from "@aptos-scp/scp-types-commerce-devices";
 import { BaseTransactionLine } from "../BaseTransactionLine";
 import { ManualDiscountLevel } from "../configuration";
+import { TenderType } from "../TenderType";
 import { BaseManualDiscountLine } from "./BaseManualDiscountLine";
-export declare class RewardCardDiscountLine extends BaseManualDiscountLine {
-    readonly _cardNumber: string;
-    readonly _discountLevel: ManualDiscountLevel;
-    readonly _rewardPrintedName: string;
-    readonly _rewardPrintedNumberLabel: string;
-    readonly _rewardCardName: string;
-    readonly _autoPopulateCardNumberFromCustomer: boolean;
-    readonly _pin: string;
+import { IRewardCardDiscountLine } from "./IRewardCardDiscountLine";
+export declare class RewardCardDiscountLine extends BaseManualDiscountLine implements IRewardCardDiscountLine {
+    private _cardNumber;
+    private _discountLevel;
+    private _rewardPrintedName;
+    private _rewardPrintedNumberLabel;
+    private _rewardCardName;
+    private _autoPopulateCardNumberFromCustomer;
+    private _pin;
     /**
      * The tenderId is the id of the tender associated with reward card authorization
      */
-    readonly _tenderId: string;
-    readonly _authResponse: IAuthorizationResponse;
-    readonly _tenderType: TenderType;
+    private _tenderId;
     /**
      * The create method is called by the transaction line factory to create an instance and initialize it from the
      * data collected during the qualification process.
@@ -40,6 +40,11 @@ export declare class RewardCardDiscountLine extends BaseManualDiscountLine {
     get rewardPrintedNumberLabel(): string;
     get tenderId(): string;
     get pin(): string;
+    get authResponse(): IAuthorizationResponse;
+    get tenderAmount(): Money;
+    get tenderType(): TenderType;
+    get authorizationDeviceId(): string;
+    get isAuthorized(): boolean;
     protected constructor(lineNumber: number, lineType: string, discountType: ManualDiscountType, discountLevel: ManualDiscountLevel, rewardPrintedName: string, rewardPrintedNumberLabel: string, rewardCardName: string, autoPopulateCardNumberFromCustomer: boolean, tenderId: string, pin: string, cardNumber: string, pricingRuleId?: string, amount?: Money, percent?: string, replacementUnitPrice?: Price, reasonCode?: string, reasonDesc?: string, reasonType?: string, couponCode?: string, supervisorOverrideLineReference?: ITransactionLineReferenceType, isEmployeeDiscount?: boolean, isFastDiscount?: boolean, competitivePrice?: Price, competitor?: string, formOfProof?: string, customCompetitorName?: string, customFormOfProof?: string, competitorCode?: string, formOfProofCode?: string, entryType?: DiscountEntryType);
     protected newTransactionLine(): BaseTransactionLine;
 }

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

@@ -80,6 +80,21 @@ class RewardCardDiscountLine extends BaseManualDiscountLine_1.BaseManualDiscount
     get pin() {
         return this._pin;
     }
+    get authResponse() {
+        return undefined;
+    }
+    get tenderAmount() {
+        return undefined;
+    }
+    get tenderType() {
+        return undefined;
+    }
+    get authorizationDeviceId() {
+        return undefined;
+    }
+    get isAuthorized() {
+        return false;
+    }
     newTransactionLine() {
         return new RewardCardDiscountLine(this.lineNumber, this.lineType, this._discountType, this._discountLevel, this._rewardPrintedName, this._rewardPrintedNumberLabel, this._rewardCardName, this._autoPopulateCardNumberFromCustomer, this._tenderId, this._pin, this._cardNumber, this._pricingRuleId, this._amount, this._percent, this._replacementUnitPrice, this._reasonCode, this._reasonDescription, this._reasonListType, this._couponCode, this._supervisorOverrideLineReference, this._isEmployeeDiscount, this._isFastDiscount, this._competitivePrice, this._competitor, this._formOfProof, this._customCompetitorName, this._customFormOfProof, this._competitorCode, this._formOfProofCode, this._entryType);
     }

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

@@ -0,0 +1,32 @@
+import { Money } from "@aptos-scp/scp-component-business-core";
+import { ITransactionLine, ITransactionLineFactory } from "@aptos-scp/scp-component-store-selling-core";
+import { IAuthorizationResponse } from "@aptos-scp/scp-types-commerce-devices";
+import { TenderType } from "../TenderType";
+import { BaseManualDiscountLineDecorator } from "./BaseManualDiscountLineDecorator";
+import { IRewardCardDiscountLine } from "./IRewardCardDiscountLine";
+import { ManualDiscountLevel } from "../configuration";
+export declare const DECORATOR_TYPE_REWARD_CARD_DISCOUNT: string;
+export declare function isRewardCardDiscountDecorator(transactionLine: ITransactionLine): transactionLine is RewardCardDiscountLineDecorator;
+export declare class RewardCardDiscountLineDecorator extends BaseManualDiscountLineDecorator implements IRewardCardDiscountLine {
+    private _authResponse;
+    private _tenderAmount;
+    private _tenderType;
+    private _authorizationDeviceId;
+    static createFromJsonObject(transactionLineJsonObj: any, transactionLineFactory: ITransactionLineFactory): RewardCardDiscountLineDecorator;
+    constructor(manualDiscountLine: IRewardCardDiscountLine, annotationSourceLineNumber: number, authResponse: IAuthorizationResponse, tenderAmount: Money, tenderType: TenderType, authorizationDeviceId: string);
+    get discountLevel(): ManualDiscountLevel;
+    get autoPopulateCardNumberFromCustomer(): boolean;
+    get cardNumber(): string;
+    get rewardPrintedName(): string;
+    get rewardCardName(): string;
+    get rewardPrintedNumberLabel(): string;
+    get tenderId(): string;
+    get pin(): string;
+    get authResponse(): IAuthorizationResponse;
+    get tenderAmount(): Money;
+    get tenderType(): TenderType;
+    get authorizationDeviceId(): string;
+    get isAuthorized(): boolean;
+    protected clone(): RewardCardDiscountLineDecorator;
+    protected newTransactionLine(): RewardCardDiscountLineDecorator;
+}

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

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const scp_component_business_core_1 = require("@aptos-scp/scp-component-business-core");
+const TenderType_1 = require("../TenderType");
+const BaseManualDiscountLineDecorator_1 = require("./BaseManualDiscountLineDecorator");
+const ANNOTATION_SOURCE_TYPE = "RewardCard";
+exports.DECORATOR_TYPE_REWARD_CARD_DISCOUNT = "REWARD_CARD_DISCOUNT_DECORATOR";
+function isRewardCardDiscountDecorator(transactionLine) {
+    return (transactionLine.lineDecoratorType ===
+        exports.DECORATOR_TYPE_REWARD_CARD_DISCOUNT);
+}
+exports.isRewardCardDiscountDecorator = isRewardCardDiscountDecorator;
+class RewardCardDiscountLineDecorator extends BaseManualDiscountLineDecorator_1.BaseManualDiscountLineDecorator {
+    constructor(manualDiscountLine, annotationSourceLineNumber, authResponse, tenderAmount, tenderType, authorizationDeviceId) {
+        super(exports.DECORATOR_TYPE_REWARD_CARD_DISCOUNT, manualDiscountLine, undefined, ANNOTATION_SOURCE_TYPE, annotationSourceLineNumber);
+        this._authResponse = authResponse;
+        this._tenderAmount = tenderAmount;
+        this._tenderType = tenderType;
+        this._authorizationDeviceId = authorizationDeviceId;
+    }
+    static createFromJsonObject(transactionLineJsonObj, transactionLineFactory) {
+        const decoratedTransactionLineJsonObj = BaseManualDiscountLineDecorator_1.BaseManualDiscountLineDecorator.getDecoratedTransactionLineJsonObjectFromJsonObject(transactionLineJsonObj);
+        const decoratedItemLine = transactionLineFactory.createTransactionLineFromJsonObj(decoratedTransactionLineJsonObj);
+        const annotationSourceLineNumber = BaseManualDiscountLineDecorator_1.BaseManualDiscountLineDecorator.getAnnotationSourceLineNumberFromJsonObject(transactionLineJsonObj);
+        const authResponse = transactionLineJsonObj._authResponse;
+        if (transactionLineJsonObj._authResponse) {
+            if (transactionLineJsonObj._authResponse.balance) {
+                authResponse.balance = new scp_component_business_core_1.Money(transactionLineJsonObj._authResponse.balance);
+            }
+            if (transactionLineJsonObj._authResponse.amount) {
+                authResponse.amount = new scp_component_business_core_1.Money(transactionLineJsonObj._authResponse.amount);
+            }
+            if (transactionLineJsonObj._authResponse.approvedAmount) {
+                authResponse.approvedAmount = new scp_component_business_core_1.Money(transactionLineJsonObj._authResponse.approvedAmount);
+            }
+        }
+        const tenderAmount = new scp_component_business_core_1.Money(transactionLineJsonObj._tenderAmount);
+        const tenderType = TenderType_1.TenderType.createFromJsonObject(transactionLineJsonObj._tenderType);
+        const authorizationDeviceId = transactionLineJsonObj._authorizationDeviceId;
+        return new RewardCardDiscountLineDecorator(decoratedItemLine, annotationSourceLineNumber, authResponse, tenderAmount, tenderType, authorizationDeviceId);
+    }
+    get discountLevel() {
+        return this.decoratedTransactionLine.discountLevel;
+    }
+    get autoPopulateCardNumberFromCustomer() {
+        return this.decoratedTransactionLine.autoPopulateCardNumberFromCustomer;
+    }
+    get cardNumber() {
+        return this.decoratedTransactionLine.cardNumber;
+    }
+    get rewardPrintedName() {
+        return this.decoratedTransactionLine.rewardPrintedName;
+    }
+    get rewardCardName() {
+        return this.decoratedTransactionLine.rewardCardName;
+    }
+    get rewardPrintedNumberLabel() {
+        return this.decoratedTransactionLine.rewardPrintedNumberLabel;
+    }
+    get tenderId() {
+        return this.decoratedTransactionLine.tenderId;
+    }
+    get pin() {
+        return this.decoratedTransactionLine.pin;
+    }
+    get authResponse() {
+        return this._authResponse;
+    }
+    get tenderAmount() {
+        return this._tenderAmount;
+    }
+    get tenderType() {
+        return this._tenderType;
+    }
+    get authorizationDeviceId() {
+        return this._authorizationDeviceId;
+    }
+    get isAuthorized() {
+        return !!this._authResponse;
+    }
+    clone() {
+        const newRewardCardRedeemDecorator = super.clone();
+        newRewardCardRedeemDecorator._authResponse = this._authResponse;
+        newRewardCardRedeemDecorator._tenderAmount = this._tenderAmount;
+        newRewardCardRedeemDecorator._tenderType = this._tenderType;
+        newRewardCardRedeemDecorator._authorizationDeviceId = this._authorizationDeviceId;
+        return newRewardCardRedeemDecorator;
+    }
+    newTransactionLine() {
+        return new RewardCardDiscountLineDecorator(this.decoratedTransactionLine, this.annotationSourceLineNumber, this._authResponse, this._tenderAmount, this._tenderType, this._authorizationDeviceId);
+    }
+}
+exports.RewardCardDiscountLineDecorator = RewardCardDiscountLineDecorator;
+//# sourceMappingURL=RewardCardDiscountLineDecorator.js.map

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

@@ -1,11 +1,14 @@
 import { Money } from "@aptos-scp/scp-component-business-core";
 import { ITransactionLineFactory } from "@aptos-scp/scp-component-store-selling-core";
-import { IManualDiscountLine } from "./IManualDiscountLine";
+import { IAuthorizationResponse } from "@aptos-scp/scp-types-commerce-devices";
 import { ManualDiscountLevel } from "../configuration";
+import { TenderType } from "../TenderType";
+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 {
+export declare class RewardCardDiscountLineTotalDecorator extends ManualDiscountLineTotalDecorator implements IRewardCardDiscountLine {
     static createFromJsonObject(transactionLineJsonObj: any, transactionLineFactory: ITransactionLineFactory): RewardCardDiscountLineTotalDecorator;
     constructor(decoratorLineType: string, decoratedTransactionLine: IManualDiscountLine, totalDiscount: Money, annotationSourceLineNumber?: number);
     get discountLevel(): ManualDiscountLevel;
@@ -16,5 +19,10 @@ export declare class RewardCardDiscountLineTotalDecorator extends ManualDiscount
     get tenderId(): string;
     get pin(): string;
     get autoPopulateCardNumberFromCustomer(): boolean;
+    get authResponse(): IAuthorizationResponse;
+    get tenderAmount(): Money;
+    get tenderType(): TenderType;
+    get authorizationDeviceId(): string;
+    get isAuthorized(): boolean;
     protected newTransactionLine(): RewardCardDiscountLineTotalDecorator;
 }

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

@@ -40,6 +40,21 @@ class RewardCardDiscountLineTotalDecorator extends ManualDiscountLineTotalDecora
     get autoPopulateCardNumberFromCustomer() {
         return this.decoratedTransactionLine.autoPopulateCardNumberFromCustomer;
     }
+    get authResponse() {
+        return this.decoratedTransactionLine.authResponse;
+    }
+    get tenderAmount() {
+        return this.decoratedTransactionLine.tenderAmount;
+    }
+    get tenderType() {
+        return this.decoratedTransactionLine.tenderType;
+    }
+    get authorizationDeviceId() {
+        return this.decoratedTransactionLine.authorizationDeviceId;
+    }
+    get isAuthorized() {
+        return this.decoratedTransactionLine.isAuthorized;
+    }
     newTransactionLine() {
         return new RewardCardDiscountLineTotalDecorator(this.lineDecoratorType, this.decoratedTransactionLine, this.totalDiscount, this.annotationSourceLineNumber);
     }

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

@@ -3,7 +3,11 @@ import { VoidSource } from "../Constants";
 import { RewardCardDiscountLine } from "./RewardCardDiscountLine";
 import { ManualDiscountLevel } from "../configuration";
 import { VoidedDiscountLineDecorator } from "./VoidedDiscountLineDecorator";
-export declare class VoidedRewardCardDiscountLineDecorator extends VoidedDiscountLineDecorator {
+import { IRewardCardDiscountLine } from "./IRewardCardDiscountLine";
+import { IAuthorizationResponse } from "@aptos-scp/scp-types-commerce-devices";
+import { Money } from "@aptos-scp/scp-component-business-core";
+import { TenderType } from "../TenderType";
+export declare class VoidedRewardCardDiscountLineDecorator extends VoidedDiscountLineDecorator implements IRewardCardDiscountLine {
     static createFromJsonObject(transactionLineJsonObj: any, transactionLineFactory: ITransactionLineFactory): VoidedRewardCardDiscountLineDecorator;
     constructor(voidSource: VoidSource, discountLine: RewardCardDiscountLine, annotationSourceLineNumber: number);
     get discountLevel(): ManualDiscountLevel;
@@ -14,5 +18,10 @@ export declare class VoidedRewardCardDiscountLineDecorator extends VoidedDiscoun
     get pin(): string;
     get rewardCardName(): string;
     get autoPopulateCardNumberFromCustomer(): boolean;
+    get authResponse(): IAuthorizationResponse;
+    get tenderAmount(): Money;
+    get tenderType(): TenderType;
+    get authorizationDeviceId(): string;
+    get isAuthorized(): boolean;
     protected newTransactionLine(): VoidedRewardCardDiscountLineDecorator;
 }

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

@@ -38,6 +38,21 @@ class VoidedRewardCardDiscountLineDecorator extends VoidedDiscountLineDecorator_
     get autoPopulateCardNumberFromCustomer() {
         return this.decoratedTransactionLine.autoPopulateCardNumberFromCustomer;
     }
+    get authResponse() {
+        return this.decoratedTransactionLine.authResponse;
+    }
+    get tenderAmount() {
+        return this.decoratedTransactionLine.tenderAmount;
+    }
+    get tenderType() {
+        return this.decoratedTransactionLine.tenderType;
+    }
+    get authorizationDeviceId() {
+        return this.decoratedTransactionLine.authorizationDeviceId;
+    }
+    get isAuthorized() {
+        return this.decoratedTransactionLine.isAuthorized;
+    }
     newTransactionLine() {
         return new VoidedRewardCardDiscountLineDecorator(this.voidSource, this.decoratedTransactionLine, this.annotationSourceLineNumber);
     }

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

@@ -1,4 +1,5 @@
 export * from "./IManualDiscountLine";
+export * from "./IRewardCardDiscountLine";
 export * from "./IPromotionCouponLine";
 export * from "./BaseManualDiscountLine";
 export * from "./LoyaltyDiscountLine";
@@ -17,6 +18,7 @@ export * from "./BaseManualDiscountLineDecorator";
 export * from "./ExpiredCouponOverrideLine";
 export * from "./RewardCardDiscountLineTotalDecorator";
 export * from "./RewardCardDiscountLine";
+export * from "./RewardCardDiscountLineDecorator";
 export * from "./VoidedRewardCardDiscountLineDecorator";
 export * from "./PromotionCouponLine";
 export * from "./employee/";

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

@@ -20,6 +20,7 @@ __export(require("./BaseManualDiscountLineDecorator"));
 __export(require("./ExpiredCouponOverrideLine"));
 __export(require("./RewardCardDiscountLineTotalDecorator"));
 __export(require("./RewardCardDiscountLine"));
+__export(require("./RewardCardDiscountLineDecorator"));
 __export(require("./VoidedRewardCardDiscountLineDecorator"));
 __export(require("./PromotionCouponLine"));
 __export(require("./employee/"));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptos-scp/scp-component-store-selling-features-domain-model",
-  "version": "2.17.0",
+  "version": "2.18.0",
   "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",
@@ -63,7 +63,7 @@
     "@aptos-scp/scp-types-client-registration": "^1.4.0",
     "@aptos-scp/scp-types-core-config": "^2.2.1",
     "@aptos-scp/scp-types-commerce-devices": "^6.0.0",
-    "@aptos-scp/scp-types-commerce-transaction": "^1.82.0",
+    "@aptos-scp/scp-types-commerce-transaction": "^1.83.0",
     "@aptos-scp/scp-types-customer": "^3.7.0",
     "@aptos-scp/scp-types-einvoice": "^1.17.0",
     "@aptos-scp/scp-types-inventory": "^2.0.0",
@@ -85,7 +85,7 @@
     "@aptos-scp/scp-component-user": "^1.4.0",
     "@aptos-scp/scp-types-client-registration": "^1.4.0",
     "@aptos-scp/scp-types-commerce-devices": "^6.3.0",
-    "@aptos-scp/scp-types-commerce-transaction": "^1.82.0",
+    "@aptos-scp/scp-types-commerce-transaction": "^1.83.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",