@aptos-scp/scp-component-store-selling-features-domain-model 1.0.0

package/lib/domain/model/user/AuthenticationFailedLine.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseTransactionLine_1 = require("../BaseTransactionLine");
+const Constants_1 = require("../Constants");
+exports.USER_AUTHENTICATION_FAILED_LINE_TYPE = "UserAuthenticationFailed";
+class AuthenticationFailedLine extends BaseTransactionLine_1.BaseTransactionLine {
+    constructor(lineNumber, lineType, username, reason) {
+        super(lineNumber, lineType);
+        this._username = username;
+        this._reason = reason;
+    }
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        const username = collectedData.get(Constants_1.CollectedDataKey.Username);
+        const reason = collectedData.get(Constants_1.CollectedDataKey.UserAuthFailureReason);
+        const authLine = new AuthenticationFailedLine(lineNumber, lineType, username, reason);
+        return authLine;
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const username = transactionLineJsonObj._username;
+        const reason = transactionLineJsonObj._reason;
+        const authLine = new AuthenticationFailedLine(lineNumber, lineType, username, reason);
+        return authLine;
+    }
+    get couldAffectPricing() {
+        return false;
+    }
+    get username() {
+        return this._username;
+    }
+    get reason() {
+        return this._reason;
+    }
+    newTransactionLine() {
+        return new AuthenticationFailedLine(this.lineNumber, this.lineType, this._username, this._reason);
+    }
+}
+exports.AuthenticationFailedLine = AuthenticationFailedLine;
+function isAuthenticationFailedLine(transactionLine) {
+    return (transactionLine instanceof AuthenticationFailedLine ||
+        transactionLine.lineType === exports.USER_AUTHENTICATION_FAILED_LINE_TYPE);
+}
+exports.isAuthenticationFailedLine = isAuthenticationFailedLine;
+//# sourceMappingURL=AuthenticationFailedLine.js.map

package/lib/domain/model/user/IPasswordExpiration.d.ts

@@ -0,0 +1,4 @@
+export interface IPasswordExpiration {
+    readonly expiringSoon: boolean;
+    readonly daysUntilExpiration: number;
+}

package/lib/domain/model/user/IPasswordExpiration.js

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

package/lib/domain/model/user/PasswordExpiration.d.ts

@@ -0,0 +1,10 @@
+import { UserAuthenticationOptions } from "@aptos-scp/scp-component-user";
+import { IPasswordExpiration } from "./IPasswordExpiration";
+export declare class PasswordExpiration implements IPasswordExpiration {
+    private readonly _daysUntilExpiration;
+    private readonly _expiringSoon;
+    static passwordExpiringSoon(passwordLastChanged: Date, options?: UserAuthenticationOptions): PasswordExpiration;
+    get daysUntilExpiration(): number;
+    get expiringSoon(): boolean;
+    protected constructor(daysUntilExpiration: number, expiringSoon: boolean);
+}

package/lib/domain/model/user/PasswordExpiration.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const moment = require("moment");
+class PasswordExpiration {
+    constructor(daysUntilExpiration, expiringSoon) {
+        this._daysUntilExpiration = daysUntilExpiration;
+        this._expiringSoon = expiringSoon;
+    }
+    static passwordExpiringSoon(passwordLastChanged, options) {
+        const currentDate = moment().format("YYYY-MM-DD");
+        if (!options ||
+            !options.numberOfDaysUntilPasswordExpiration ||
+            !options.daysForPasswordExpirationWarning) {
+            return new PasswordExpiration(0, false);
+        }
+        const expirationDate = moment
+            .utc(passwordLastChanged, "YYYY-MM-DDTHH:mm:ss")
+            .add(options.numberOfDaysUntilPasswordExpiration, "d")
+            .format("YYYY-MM-DD");
+        const showWarningDate = moment(moment.utc(expirationDate, "YYYY-MM-DDTHH:mm:ss"))
+            .subtract(options.daysForPasswordExpirationWarning, "d")
+            .format("YYYY-MM-DD");
+        const expiringSoon = moment(showWarningDate).isSameOrBefore(currentDate) &&
+            moment(expirationDate).isSameOrAfter(currentDate);
+        const daysUntilExpiration = moment(currentDate).isBefore(moment(expirationDate))
+            ? moment.duration(moment(expirationDate).diff(currentDate)).asDays()
+            : 0;
+        return new PasswordExpiration(daysUntilExpiration, expiringSoon);
+    }
+    get daysUntilExpiration() {
+        return this._daysUntilExpiration;
+    }
+    get expiringSoon() {
+        return this._expiringSoon;
+    }
+}
+exports.PasswordExpiration = PasswordExpiration;
+//# sourceMappingURL=PasswordExpiration.js.map

package/lib/domain/model/user/UserLine.d.ts

@@ -0,0 +1,33 @@
+import { ITransactionLine, IUser, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { IServiceResult } from "@aptos-scp/scp-types-commerce-transaction";
+import { BaseTransactionLine } from "../BaseTransactionLine";
+import { IServiceResultLine } from "../IServiceResultLine";
+export declare const LOG_ON_LINE_TYPE = "LogOn";
+export declare const LOG_OFF_LINE_TYPE = "LogOff";
+export declare const PASSWORD_CHANGED_LINE_TYPE = "PasswordChanged";
+export declare const UPDATED_USER_PREFERENCES_LINE_TYPE = "UpdatedUserPreferences";
+export declare class UserLine extends BaseTransactionLine implements IServiceResultLine {
+    private _user;
+    private _autoLogoff;
+    private _serviceResult;
+    /**
+     * 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.
+     *
+     * @param {number} lineNumber                        The line number of this line in the transaction
+     * @param {string} lineType                          The type of line
+     * @param {UiBusinessEvent} uiBusinessEvent          The UI business event that led to the creation of this line
+     * @param {Readonly<Map<string, any>>} collectedData The data collected during the qualification process
+     *
+     * @return {UserLine}
+     */
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): UserLine;
+    static createFromJsonObject(transactionLineJsonObj: any): UserLine;
+    get couldAffectPricing(): boolean;
+    get user(): IUser;
+    get autoLogoff(): boolean;
+    get serviceResult(): IServiceResult;
+    protected constructor(lineNumber: number, lineType: string, user: IUser, autoLogoff: boolean, serviceResult?: IServiceResult);
+    protected newTransactionLine(): BaseTransactionLine;
+}
+export declare function isUserLine(transactionLine: ITransactionLine): transactionLine is UserLine;

package/lib/domain/model/user/UserLine.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = require("..");
+const BaseTransactionLine_1 = require("../BaseTransactionLine");
+const User_1 = require("../User");
+exports.LOG_ON_LINE_TYPE = "LogOn";
+exports.LOG_OFF_LINE_TYPE = "LogOff";
+exports.PASSWORD_CHANGED_LINE_TYPE = "PasswordChanged";
+exports.UPDATED_USER_PREFERENCES_LINE_TYPE = "UpdatedUserPreferences";
+class UserLine extends BaseTransactionLine_1.BaseTransactionLine {
+    // Since the constructor is only called from the create methods it is made protected to prevent use by others.
+    constructor(lineNumber, lineType, user, autoLogoff, serviceResult) {
+        super(lineNumber, lineType);
+        this._user = user;
+        this._autoLogoff = autoLogoff;
+        this._serviceResult = serviceResult;
+    }
+    /**
+     * 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.
+     *
+     * @param {number} lineNumber                        The line number of this line in the transaction
+     * @param {string} lineType                          The type of line
+     * @param {UiBusinessEvent} uiBusinessEvent          The UI business event that led to the creation of this line
+     * @param {Readonly<Map<string, any>>} collectedData The data collected during the qualification process
+     *
+     * @return {UserLine}
+     */
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        const user = collectedData.get(User_1.USER);
+        const autoLogoff = collectedData.get(User_1.LOG_OFF_TYPE) === User_1.AUTO_LOG_OFF_TYPE;
+        const serviceResult = collectedData.get(__1.CollectedDataKey.ServiceResult);
+        const userLine = new UserLine(lineNumber, lineType, user, autoLogoff, serviceResult);
+        return userLine;
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const user = User_1.User.createFromJsonObject(transactionLineJsonObj._user);
+        const autoLogoff = transactionLineJsonObj._autoLogoff;
+        const userLine = new UserLine(lineNumber, lineType, user, autoLogoff);
+        userLine.loadFromJsonObject(transactionLineJsonObj);
+        return userLine;
+    }
+    get couldAffectPricing() {
+        return false;
+    }
+    get user() {
+        return this._user;
+    }
+    get autoLogoff() {
+        return this._autoLogoff;
+    }
+    get serviceResult() {
+        return this._serviceResult;
+    }
+    /* Since all properties are copied by the constructor in newTransactionLine, this just calls
+       super.loadFromJsonObject().
+       This is left here commented-out as a reminder that, if properties are added that are not handled by the
+       constructor, then this needs to be implemented.
+    protected loadFromJsonObject(transactionLineJsonObj: any): void {
+      super.loadFromJsonObject(transactionLineJsonObj);
+  
+      // These are copied by the constructor
+      //this._user = transactionLineJsonObj._user;
+    }
+    */
+    newTransactionLine() {
+        return new UserLine(this.lineNumber, this.lineType, this._user, this._autoLogoff, this._serviceResult);
+    }
+}
+exports.UserLine = UserLine;
+function isUserLine(transactionLine) {
+    return (transactionLine instanceof UserLine ||
+        ((transactionLine.lineType === exports.LOG_ON_LINE_TYPE ||
+            transactionLine.lineType === exports.LOG_OFF_LINE_TYPE ||
+            transactionLine.lineType === exports.PASSWORD_CHANGED_LINE_TYPE ||
+            transactionLine.lineType === exports.UPDATED_USER_PREFERENCES_LINE_TYPE ||
+            transactionLine.lineType === User_1.EXIT_ATTENDANT_MODE_LINE_TYPE ||
+            transactionLine.lineType === User_1.ENTER_ATTENDANT_MODE_LINE_TYPE) &&
+            transactionLine.user !== undefined));
+}
+exports.isUserLine = isUserLine;
+//# sourceMappingURL=UserLine.js.map

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

@@ -0,0 +1,4 @@
+export * from "./IPasswordExpiration";
+export * from "./PasswordExpiration";
+export * from "./UserLine";
+export * from "./AuthenticationFailedLine";

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

@@ -0,0 +1,9 @@
+"use strict";
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+__export(require("./PasswordExpiration"));
+__export(require("./UserLine"));
+__export(require("./AuthenticationFailedLine"));
+//# sourceMappingURL=index.js.map

package/lib/domain/model/void/LineVoidLine.d.ts

@@ -0,0 +1,50 @@
+import { Money } from "@aptos-scp/scp-component-business-core";
+import { ITransactionLine, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { IAuthorizationResponse } from "@aptos-scp/scp-types-commerce-devices";
+import { ICouponAuthorizationServiceResult, ITransactionLineReferenceType } from "@aptos-scp/scp-types-commerce-transaction";
+import { BaseTransactionLine } from "../BaseTransactionLine";
+import { TenderType } from "../TenderType";
+import { IVoidingLine } from "../VoidInterfaces";
+export declare const LINE_VOID_LINE_TYPE: string;
+/**
+ * The LineVoidLine Captures the action by the user (directly or indirectly through a transaction void) to void the
+ * line.  It includes a compensating extended amount.  This does not compensate fot the tax, though as not all lines
+ * have tax.  That is done by the VoidedItemLineDecorator.
+ */
+export declare class LineVoidLine extends BaseTransactionLine implements IVoidingLine {
+    private _voidedLineNumber;
+    private _couldAffectPricing;
+    private _couldAffectTaxation;
+    private _transactionVoidLineNumber;
+    private _authResponse;
+    private _tenderType;
+    private _couponAuthorizationServiceResult;
+    private _supervisorOverrideLineReference;
+    /**
+     * 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.
+     *
+     * @param {number} lineNumber                        The line number of this line in the transaction
+     * @param {string} lineType                          The type of line
+     * @param {UiBusinessEvent} uiBusinessEvent          The UI business event that led to the creation of this line
+     * @param {Readonly<Map<string, any>>} collectedData The data collected during the qualification process
+     *
+     * @return {LineVoidLine}
+     */
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): LineVoidLine;
+    static createFromJsonObject(transactionLineJsonObj: any): LineVoidLine;
+    get couldAffectPricing(): boolean;
+    get couldAffectTaxation(): boolean;
+    get voidingLine(): boolean;
+    get voidedLineNumber(): number;
+    get transactionVoidLineNumber(): number;
+    get authResponse(): IAuthorizationResponse;
+    get tenderId(): string;
+    get tenderName(): string;
+    get tenderType(): TenderType;
+    get supervisorOverrideLineReference(): ITransactionLineReferenceType;
+    get couponAuthorizationServiceResult(): ICouponAuthorizationServiceResult;
+    protected constructor(lineNumber: number, lineType: string, extendedAmount: Money, voidedLineNumber: number, couldAffectPricing: boolean, couldAffectTaxation: boolean, transactionVoidLineNumber: number, authResponse: IAuthorizationResponse, supervisorOverrideLineReference: ITransactionLineReferenceType, couponAuthorizationServiceResult: ICouponAuthorizationServiceResult, tenderType?: TenderType, extendedAmountExcludingTax?: Money, extendedAmountIncludingTax?: Money);
+    protected newTransactionLine(): BaseTransactionLine;
+}
+export declare function isLineVoidLine(transactionLine: ITransactionLine): transactionLine is LineVoidLine;

package/lib/domain/model/void/LineVoidLine.js

@@ -0,0 +1,158 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const scp_component_business_core_1 = require("@aptos-scp/scp-component-business-core");
+const scp_component_store_selling_core_1 = require("@aptos-scp/scp-component-store-selling-core");
+const config_1 = require("../../../config");
+const BaseTransactionLine_1 = require("../BaseTransactionLine");
+const Constants_1 = require("../Constants");
+const TenderType_1 = require("../TenderType");
+exports.LINE_VOID_LINE_TYPE = "LineVoid";
+/**
+ * The LineVoidLine Captures the action by the user (directly or indirectly through a transaction void) to void the
+ * line.  It includes a compensating extended amount.  This does not compensate fot the tax, though as not all lines
+ * have tax.  That is done by the VoidedItemLineDecorator.
+ */
+class LineVoidLine extends BaseTransactionLine_1.BaseTransactionLine {
+    // Since the constructor is only called from the create methods it is made protected to prevent use by others.
+    constructor(lineNumber, lineType, extendedAmount, voidedLineNumber, couldAffectPricing, couldAffectTaxation, transactionVoidLineNumber, authResponse, supervisorOverrideLineReference, couponAuthorizationServiceResult, tenderType, extendedAmountExcludingTax, extendedAmountIncludingTax) {
+        super(lineNumber, lineType, extendedAmount, extendedAmountExcludingTax, extendedAmountIncludingTax);
+        this._voidedLineNumber = voidedLineNumber;
+        this._couldAffectPricing = couldAffectPricing;
+        this._couldAffectTaxation = couldAffectTaxation;
+        this._transactionVoidLineNumber = transactionVoidLineNumber;
+        this._authResponse = authResponse;
+        this._supervisorOverrideLineReference = supervisorOverrideLineReference;
+        this._couponAuthorizationServiceResult = couponAuthorizationServiceResult;
+        this._tenderType = tenderType;
+    }
+    /**
+     * 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.
+     *
+     * @param {number} lineNumber                        The line number of this line in the transaction
+     * @param {string} lineType                          The type of line
+     * @param {UiBusinessEvent} uiBusinessEvent          The UI business event that led to the creation of this line
+     * @param {Readonly<Map<string, any>>} collectedData The data collected during the qualification process
+     *
+     * @return {LineVoidLine}
+     */
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        // Note: We might want to support a TRX_VOID_LINE_VOID_LINE_TYPE type.
+        if (!(lineType === exports.LINE_VOID_LINE_TYPE)) {
+            throw new scp_component_store_selling_core_1.PosError(`The line type "${lineType}" is not supported by LineVoidLine`, config_1.SSF_LINE_TYPE_ERROR_CODE);
+        }
+        const extendedAmount = collectedData.get("extendedAmount") && collectedData.get("extendedAmount").times(-1);
+        const voidedLineNumber = collectedData.get("lineNumber");
+        const couldAffectPricing = collectedData.get("couldAffectPricing");
+        const couldAffectTaxation = collectedData.get("couldAffectTaxation");
+        const transactionVoidLineNumber = collectedData.has("transactionVoidLineNumber")
+            ? collectedData.get("transactionVoidLineNumber")
+            : undefined;
+        const authResponse = collectedData.get(Constants_1.CollectedDataKey.TenderAuthResponse);
+        const tenderType = collectedData.get(Constants_1.CollectedDataKey.TenderType);
+        const supervisorOverrideLineReference = collectedData.get(Constants_1.CollectedDataKey.SupervisorOverrideLineReference) || undefined;
+        const couponAuthorizationServiceResult = collectedData.get(Constants_1.CollectedDataKey.CouponServiceResult) || undefined;
+        return new LineVoidLine(lineNumber, lineType, extendedAmount, voidedLineNumber, couldAffectPricing, couldAffectTaxation, transactionVoidLineNumber, authResponse, supervisorOverrideLineReference, couponAuthorizationServiceResult, tenderType);
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const extendedAmount = BaseTransactionLine_1.BaseTransactionLine.extendedAmountFromJsonObject(transactionLineJsonObj);
+        const extendedAmountExcludingTax = BaseTransactionLine_1.BaseTransactionLine.extendedAmountExcludingTaxFromJsonObject(transactionLineJsonObj);
+        const extendedAmountIncludingTax = BaseTransactionLine_1.BaseTransactionLine.extendedAmountIncludingTaxFromJsonObject(transactionLineJsonObj);
+        const voidedLineNumber = transactionLineJsonObj._voidedLineNumber;
+        const couldAffectPricing = transactionLineJsonObj._couldAffectPricing;
+        const couldAffectTaxation = transactionLineJsonObj._couldAffectTaxation;
+        const transactionVoidLineNumber = transactionLineJsonObj._transactionVoidLineNumber;
+        const authResponse = transactionLineJsonObj._authResponse;
+        const tenderType = TenderType_1.TenderType.createFromJsonObject(transactionLineJsonObj._tenderType);
+        const supervisorOverrideLineReference = transactionLineJsonObj._supervisorOverrideLineReference;
+        const couponAuthorizationServiceResult = transactionLineJsonObj._couponAuthorizationServiceResult;
+        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 lineVoidLine = new LineVoidLine(lineNumber, lineType, extendedAmount, voidedLineNumber, couldAffectPricing, couldAffectTaxation, transactionVoidLineNumber, authResponse, supervisorOverrideLineReference, couponAuthorizationServiceResult, tenderType, extendedAmountExcludingTax, extendedAmountIncludingTax);
+        lineVoidLine.loadFromJsonObject(transactionLineJsonObj);
+        return lineVoidLine;
+    }
+    /* Since all properties are copied by the constructor in newTransactionLine, this just calls super.clone().
+       This is left here commented-out as a reminder that, if properties are added that are not handled by the
+       constructor, then this needs to be implemented.
+    public clone(): ITransactionLine {
+      let newLineVoidLine: LineVoidLine = super.clone() as LineVoidLine;
+  
+      // All properties are copied by the constructor.
+  
+      return newLineVoidLine;
+    }
+    */
+    get couldAffectPricing() {
+        return this._couldAffectPricing;
+    }
+    get couldAffectTaxation() {
+        return this._couldAffectTaxation;
+    }
+    // For IVoidingLine
+    get voidingLine() {
+        return true;
+    }
+    get voidedLineNumber() {
+        return this._voidedLineNumber;
+    }
+    get transactionVoidLineNumber() {
+        return this._transactionVoidLineNumber;
+    }
+    get authResponse() {
+        return this._authResponse;
+    }
+    get tenderId() {
+        return this.tenderType ? this.tenderType.id : undefined;
+    }
+    get tenderName() {
+        return this.tenderType ? this.tenderType.tenderName : undefined;
+    }
+    get tenderType() {
+        return this._tenderType;
+    }
+    get supervisorOverrideLineReference() {
+        return this._supervisorOverrideLineReference;
+    }
+    get couponAuthorizationServiceResult() {
+        return this._couponAuthorizationServiceResult;
+    }
+    /* Since all properties are copied by the constructor in newTransactionLine, this just calls
+       super.loadFromJsonObject().
+       This is left here commented-out as a reminder that, if properties are added that are not handled by the
+       constructor, then this needs to be implemented.
+    protected loadFromJsonObject(transactionLineJsonObj: any): void {
+      super.loadFromJsonObject(transactionLineJsonObj);
+  
+      // These are all copied by the constructor.
+      //this._voidedLineNumber =  transactionLineJsonObj._voidedLineNumber;
+      //this._extendedAmountBeforeVoid =  new Money(transactionLineJsonObj._extendedAmountBeforeVoid);
+  
+      //if (transactionLineJsonObj._transactionVoidLineNumber) {
+      //  this._transactionVoidLineNumber = transactionLineJsonObj._transactionVoidLineNumber;
+      //}
+    }
+    */
+    newTransactionLine() {
+        return new LineVoidLine(this.lineNumber, this.lineType, this.extendedAmount, this._voidedLineNumber, this._couldAffectPricing, this._couldAffectTaxation, this._transactionVoidLineNumber, this._authResponse, this._supervisorOverrideLineReference, this._couponAuthorizationServiceResult, this._tenderType);
+    }
+}
+exports.LineVoidLine = LineVoidLine;
+// Instead of using this guard function, consider, using isVoidingLine from the VoidInterfaced.
+// This is useful, when you need to know you are working with this class, and not just a voidable/voiding line.
+function isLineVoidLine(transactionLine) {
+    return transactionLine instanceof LineVoidLine || transactionLine.lineType === exports.LINE_VOID_LINE_TYPE;
+}
+exports.isLineVoidLine = isLineVoidLine;
+//# sourceMappingURL=LineVoidLine.js.map

package/lib/domain/model/void/TransactionVoidLine.d.ts

@@ -0,0 +1,34 @@
+import { ITransactionLine, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { ITransactionLineReferenceType } from "@aptos-scp/scp-types-commerce-transaction";
+import { BaseTransactionLine } from "../BaseTransactionLine";
+import { IVoidingLine } from "../VoidInterfaces";
+export declare const TRANSACTION_VOID_LINE_TYPE: string;
+export declare const POST_TRANSACTION_VOID_LINE_TYPE: string;
+export declare class TransactionVoidLine extends BaseTransactionLine implements IVoidingLine {
+    private _supervisorOverrideLineReference;
+    private _reasonCode;
+    private _reasonDescription;
+    private _reasonListType;
+    /**
+     * 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.
+     *
+     * @param {number} lineNumber                        The line number of this line in the transaction
+     * @param {string} lineType                          The type of line
+     * @param {UiBusinessEvent} uiBusinessEvent          The UI business event that led to the creation of this line
+     * @param {Readonly<Map<string, any>>} collectedData The data collected during the qualification process
+     *
+     * @return {TransactionVoidLine}
+     */
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): TransactionVoidLine;
+    static createFromJsonObject(transactionLineJsonObj: any): TransactionVoidLine;
+    get couldAffectPricing(): boolean;
+    get supervisorOverrideLineReference(): ITransactionLineReferenceType;
+    get reasonCode(): string;
+    get reasonDescription(): string;
+    get reasonListType(): string;
+    protected constructor(lineNumber: number, lineType: string, accountingCurrency: string, supervisorOverrideLineReference: ITransactionLineReferenceType, reasonCode: string, reasonDesc: string, reasonType: string);
+    get voidingLine(): boolean;
+    protected newTransactionLine(): BaseTransactionLine;
+}
+export declare function isTransactionVoidLine(transactionLine: ITransactionLine): transactionLine is TransactionVoidLine;

package/lib/domain/model/void/TransactionVoidLine.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const scp_component_business_core_1 = require("@aptos-scp/scp-component-business-core");
+const scp_component_store_selling_core_1 = require("@aptos-scp/scp-component-store-selling-core");
+const config_1 = require("../../../config");
+const BaseTransactionLine_1 = require("../BaseTransactionLine");
+const Constants_1 = require("../Constants");
+exports.TRANSACTION_VOID_LINE_TYPE = "TransactionVoid";
+exports.POST_TRANSACTION_VOID_LINE_TYPE = "PostTransactionVoid";
+class TransactionVoidLine extends BaseTransactionLine_1.BaseTransactionLine {
+    // Only the create methods should create an instance, so this constructor is protected to prevent instantiation by
+    // others.
+    constructor(lineNumber, lineType, accountingCurrency, supervisorOverrideLineReference, reasonCode, reasonDesc, reasonType) {
+        super(lineNumber, lineType, new scp_component_business_core_1.Money(0.0, accountingCurrency));
+        this._supervisorOverrideLineReference = supervisorOverrideLineReference;
+        this._reasonCode = reasonCode;
+        this._reasonCode = reasonCode;
+        this._reasonDescription = reasonDesc;
+        this._reasonListType = reasonType;
+    }
+    /**
+     * 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.
+     *
+     * @param {number} lineNumber                        The line number of this line in the transaction
+     * @param {string} lineType                          The type of line
+     * @param {UiBusinessEvent} uiBusinessEvent          The UI business event that led to the creation of this line
+     * @param {Readonly<Map<string, any>>} collectedData The data collected during the qualification process
+     *
+     * @return {TransactionVoidLine}
+     */
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        if (lineType !== exports.TRANSACTION_VOID_LINE_TYPE && lineType !== exports.POST_TRANSACTION_VOID_LINE_TYPE) {
+            throw new scp_component_store_selling_core_1.PosError(`TransactionVoidLine does not support the line type "${lineType}".`, config_1.SSF_LINE_TYPE_ERROR_CODE);
+        }
+        const accountingCurrency = collectedData.get("accountingCurrency");
+        const supervisorOverrideLineReference = collectedData.get(Constants_1.CollectedDataKey.SupervisorOverrideLineReference) || undefined;
+        const reasonCode = collectedData.get(Constants_1.CollectedDataKey.ReasonCode) || undefined;
+        const reasonDesc = collectedData.get(Constants_1.CollectedDataKey.ReasonDescription) || undefined;
+        const reasonType = collectedData.get(Constants_1.CollectedDataKey.ReasonListType) || undefined;
+        return new TransactionVoidLine(lineNumber, lineType, accountingCurrency, supervisorOverrideLineReference, reasonCode, reasonDesc, reasonType);
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        // Extended amount is always set so it is safe to load it to get the currency
+        const accountingCurrency = transactionLineJsonObj._extendedAmount.currency;
+        const supervisorOverrideLineReference = transactionLineJsonObj._supervisorOverrideLineReference;
+        const reasonCode = transactionLineJsonObj._reasonCode;
+        const reasonDesc = transactionLineJsonObj._reasonDescription;
+        const reasonType = transactionLineJsonObj._reasonListType;
+        const transactionVoidLine = new TransactionVoidLine(lineNumber, lineType, accountingCurrency, supervisorOverrideLineReference, reasonCode, reasonDesc, reasonType);
+        transactionVoidLine.loadFromJsonObject(transactionLineJsonObj);
+        return transactionVoidLine;
+    }
+    get couldAffectPricing() {
+        return true;
+    }
+    get supervisorOverrideLineReference() {
+        return this._supervisorOverrideLineReference;
+    }
+    get reasonCode() {
+        return this._reasonCode;
+    }
+    get reasonDescription() {
+        return this._reasonDescription;
+    }
+    get reasonListType() {
+        return this._reasonListType;
+    }
+    // For IVoidingLine
+    get voidingLine() {
+        return true;
+    }
+    newTransactionLine() {
+        return new TransactionVoidLine(this.lineNumber, this.lineType, this.extendedAmount.currency, this._supervisorOverrideLineReference, this._reasonCode, this._reasonDescription, this._reasonListType);
+    }
+}
+exports.TransactionVoidLine = TransactionVoidLine;
+function isTransactionVoidLine(transactionLine) {
+    return (transactionLine instanceof TransactionVoidLine ||
+        transactionLine.lineType === exports.TRANSACTION_VOID_LINE_TYPE ||
+        transactionLine.lineType === exports.POST_TRANSACTION_VOID_LINE_TYPE);
+}
+exports.isTransactionVoidLine = isTransactionVoidLine;
+//# sourceMappingURL=TransactionVoidLine.js.map

package/lib/domain/model/void/VoidedLineDecorator.d.ts

@@ -0,0 +1,10 @@
+import { ITransactionLine, ITransactionLineFactory } from "@aptos-scp/scp-component-store-selling-core";
+import { BaseLineDecorator } from "../BaseLineDecorator";
+export declare const DECORATOR_TYPE_VOIDED_LINE: string;
+export declare const DECORATOR_DESCRIPTION_VOIDED: string;
+export declare class VoidedLineDecorator<T extends ITransactionLine> extends BaseLineDecorator<T> {
+    static createFromJsonObject(transactionLineJsonObj: any, transactionLineFactory: ITransactionLineFactory): VoidedLineDecorator<any>;
+    constructor(decoratedTransactionLine: T, annotationSourceLineNumber: number);
+    get voided(): boolean;
+    protected newTransactionLine(): VoidedLineDecorator<T>;
+}

package/lib/domain/model/void/VoidedLineDecorator.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseLineDecorator_1 = require("../BaseLineDecorator");
+const VOIDED_ANNOTATION_SOURCE_TYPE = "Voided";
+exports.DECORATOR_TYPE_VOIDED_LINE = "VOIDED_LINE_DECORATOR";
+exports.DECORATOR_DESCRIPTION_VOIDED = "VOIDED";
+// TODO: Convert DECORATOR_DESCRIPTION_VOIDED into an ILocalizableMessage, when that is supported.
+// export const DECORATOR_DESCRIPTION_VOIDED: ILocalizableMessage = {
+//   defaultMessage: "VOIDED",
+//   i18nCode: "voided"
+// };
+class VoidedLineDecorator extends BaseLineDecorator_1.BaseLineDecorator {
+    static createFromJsonObject(transactionLineJsonObj, transactionLineFactory) {
+        const decoratedTransactionLineJsonObj = BaseLineDecorator_1.BaseLineDecorator.getDecoratedTransactionLineJsonObjectFromJsonObject(transactionLineJsonObj);
+        const decoratedLine = transactionLineFactory.createTransactionLineFromJsonObj(decoratedTransactionLineJsonObj);
+        const annotationSourceLineNumber = BaseLineDecorator_1.BaseLineDecorator.getAnnotationSourceLineNumberFromJsonObject(transactionLineJsonObj);
+        const voidedLineDecorator = new VoidedLineDecorator(decoratedLine, annotationSourceLineNumber);
+        return voidedLineDecorator;
+    }
+    constructor(decoratedTransactionLine, annotationSourceLineNumber) {
+        super(exports.DECORATOR_TYPE_VOIDED_LINE, decoratedTransactionLine, exports.DECORATOR_DESCRIPTION_VOIDED, VOIDED_ANNOTATION_SOURCE_TYPE, annotationSourceLineNumber);
+    }
+    /* Since this just calls super.clone(), we don't need this implemented here.
+       This is left her, commented out, so that if future changes add any properties that are not handled by the
+       constructor, it will be a reminder to include it.
+    public clone(): VoidedLineDecorator {
+      let newVoidedLineDecorator: VoidedLineDecorator = super.clone<VoidedLineDecorator>();
+  
+      return newVoidedLineDecorator;
+    }
+    */
+    get voided() {
+        return true;
+    }
+    newTransactionLine() {
+        return new VoidedLineDecorator(this.decoratedTransactionLine, this.annotationSourceLineNumber);
+    }
+}
+exports.VoidedLineDecorator = VoidedLineDecorator;
+//# sourceMappingURL=VoidedLineDecorator.js.map

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

@@ -0,0 +1,3 @@
+export * from "./LineVoidLine";
+export * from "./TransactionVoidLine";
+export * from "./VoidedLineDecorator";

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

@@ -0,0 +1,9 @@
+"use strict";
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+__export(require("./LineVoidLine"));
+__export(require("./TransactionVoidLine"));
+__export(require("./VoidedLineDecorator"));
+//# sourceMappingURL=index.js.map