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

package/lib/domain/model/TransactionFlowState.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const scp_component_logging_1 = require("@aptos-scp/scp-component-logging");
+const logger = scp_component_logging_1.LogManager.getLogger("com.aptos.storesellingfeatures.domain.model.UserSession");
+var TransactionFlowSessionState;
+(function (TransactionFlowSessionState) {
+    TransactionFlowSessionState["BasketUpdate"] = "BasketUpdate";
+    TransactionFlowSessionState["Totaled"] = "Totaled";
+    TransactionFlowSessionState["BasketUpdatePostTotal"] = "BasketUpdatePostTotal";
+    TransactionFlowSessionState["Tendering"] = "Tendering";
+    TransactionFlowSessionState["FlowNotTracked"] = "FlowNotTracked";
+    TransactionFlowSessionState["NotInTransaction"] = "NotInTransaction";
+})(TransactionFlowSessionState = exports.TransactionFlowSessionState || (exports.TransactionFlowSessionState = {}));
+exports.TRANSACTION_FLOW_STATE = "TransactionFlowState";
+class TransactionFlowState {
+    constructor(state) {
+        this._type = exports.TRANSACTION_FLOW_STATE;
+        this._state = state;
+    }
+    static create() {
+        logger.traceEntry("create");
+        return new TransactionFlowState(undefined);
+    }
+    static createFromJsonObject(userSessionJsonObj) {
+        logger.traceEntry("createFromJsonObject");
+        return new TransactionFlowState(userSessionJsonObj._state);
+    }
+    get type() {
+        return this._type;
+    }
+    get state() {
+        return this._state;
+    }
+    startedMerchandiseTransaction() {
+        return new TransactionFlowState(TransactionFlowSessionState.BasketUpdate);
+    }
+    totaledTransaction() {
+        if (this.state === TransactionFlowSessionState.BasketUpdate ||
+            this.state === TransactionFlowSessionState.BasketUpdatePostTotal) {
+            return new TransactionFlowState(TransactionFlowSessionState.Totaled);
+        }
+        return this;
+    }
+    tendered() {
+        if (this.state !== TransactionFlowSessionState.FlowNotTracked) {
+            return new TransactionFlowState(TransactionFlowSessionState.Tendering);
+        }
+    }
+    modifiedTransaction() {
+        if (this.state === TransactionFlowSessionState.Totaled ||
+            this.state === TransactionFlowSessionState.Tendering) {
+            return new TransactionFlowState(TransactionFlowSessionState.BasketUpdatePostTotal);
+        }
+        else {
+            if (this.state !== TransactionFlowSessionState.FlowNotTracked) {
+                return new TransactionFlowState(TransactionFlowSessionState.BasketUpdate);
+            }
+        }
+    }
+    startedOtherTransaction() {
+        return new TransactionFlowState(TransactionFlowSessionState.FlowNotTracked);
+    }
+    closedTransaction() {
+        return new TransactionFlowState(TransactionFlowSessionState.NotInTransaction);
+    }
+    get stateValues() {
+        logger.traceEntry("get stateValues");
+        return new Map([["TransactionFlowState.state", this._state]]);
+    }
+}
+exports.TransactionFlowState = TransactionFlowState;
+//# sourceMappingURL=TransactionFlowState.js.map

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

@@ -0,0 +1,112 @@
+import { IMoney } from "@aptos-scp/scp-component-business-core";
+import { ITransactionLine, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { IFiscalSignature, IOrderReferenceInfo, IOriginalPromotionCouponInfo, MerchandiseTransactionClosingState, ReceiptCategory, TransactionType } from "@aptos-scp/scp-types-commerce-transaction";
+import { BaseTransactionLine } from "./BaseTransactionLine";
+export declare const TRANSACTION_REFERENCE_LINE_TYPE = "TransactionReference";
+export declare const START_POST_VOID_TRANSACTION_LINE_TYPE = "StartPostVoid";
+export declare class TransactionReferenceLine extends BaseTransactionLine {
+    /**
+     * This is a stand-alone unique identifier (UUID) for the transaction.
+     */
+    private _transactionId;
+    private _tenantId;
+    private _retailLocationId;
+    private _deviceId;
+    private _businessDayDate;
+    private _transactionNumber;
+    private _transactionStartDateTime;
+    private _transactionEndDateTime;
+    private _transactionType;
+    private _inputSource;
+    private _closingState?;
+    private _zReportNumber?;
+    private _fiscalId?;
+    private _fiscalYReceiptNumber?;
+    private _printerSerialNumber?;
+    private _fiscalReceiptDate?;
+    private _referenceNumber?;
+    private _isTransactionForReturnReference?;
+    private _isTransactionForOfflineReturnReference?;
+    private _taxLotteryCustomerCode?;
+    private _invoiceNumber?;
+    private _workstationNumber?;
+    private _orderReference?;
+    private _originalPromotionCoupons?;
+    private _originalTradeType?;
+    private _storeName?;
+    private _fiscalTransactionNumber?;
+    private _fiscalTypeCode?;
+    private _fiscalTransactionStartDateTime?;
+    private _fiscalTransactionEndDateTime?;
+    private _fiscalSignature?;
+    private _invoiceSequenceNumber?;
+    private _invoiceFiscalTransactionNumber?;
+    private _invoiceTransactionNumber?;
+    private _orderFulfillmentType?;
+    private _transactionTotal?;
+    private _originalReceiptCategory?;
+    private _timezoneOffsetInMinutes?;
+    /**
+     * 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:
+     *                                                   <ul>
+     *                                                   <li>tenantId</li>
+     *                                                   <li>retailLocationId</li>
+     *                                                   <li>deviceId</li>
+     *                                                   <li>businessDayDate</li>
+     *                                                   <li>transactionNumber</li>
+     *                                                   <li>transactionId</li>
+     *                                                   </ul>
+     *
+     * @return {TenderLine}
+     */
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): TransactionReferenceLine;
+    static createFromJsonObject(transactionLineJsonObj: any): TransactionReferenceLine;
+    get couldAffectPricing(): boolean;
+    get tenantId(): string;
+    get printerSerialNumber(): string;
+    get fiscalReceiptDate(): string;
+    get referenceNumber(): string;
+    get originalTradeType(): string;
+    get fiscalTransactionNumber(): string;
+    get invoiceFiscalTransactionNumber(): string;
+    get invoiceTransactionNumber(): number;
+    get fiscalTypeCode(): string;
+    get fiscalTransactionStartDateTime(): string;
+    get fiscalTransactionEndDateTime(): string;
+    get fiscalSignature(): IFiscalSignature;
+    get storeName(): string;
+    get zReportNumber(): string;
+    get orderFulfillmentType(): string;
+    get transactionTotal(): IMoney;
+    get originalReceiptCategory(): ReceiptCategory;
+    get fiscalId(): string;
+    get fiscalYReceiptNumber(): string;
+    get retailLocationId(): string;
+    get deviceId(): string;
+    get businessDayDate(): string;
+    get transactionNumber(): number;
+    get transactionId(): string;
+    get transactionStartDateTime(): Date;
+    get transactionEndDateTime(): Date;
+    get transactionType(): TransactionType;
+    get timezoneOffsetInMinutes(): number;
+    get inputSource(): string;
+    get closingState(): MerchandiseTransactionClosingState;
+    get isTransactionForReturnReference(): boolean;
+    get isTransactionForOfflineReturnReference(): boolean;
+    get taxLotteryCustomerCode(): string;
+    get invoiceNumber(): string;
+    get invoiceSequenceNumber(): number;
+    get workstationNumber(): number;
+    get orderReference(): IOrderReferenceInfo;
+    get originalPromotionCoupons(): IOriginalPromotionCouponInfo[];
+    protected constructor(lineNumber: number, lineType: string, tenantId: string, retailLocationId: string, deviceId: string, businessDayDate: string, transactionNumber: number, transactionId: string, transactionStartDateTime?: Date, transactionEndDateTime?: Date, transactionType?: TransactionType, inputSource?: string, closingState?: MerchandiseTransactionClosingState, zReportNumber?: string, fiscalId?: string, fiscalYReceiptNumber?: string, printerSerialNumber?: string, referenceNumber?: string, isTransactionForReturnReference?: boolean, fiscalReceiptDate?: string, taxLotteryCustomerCode?: string, isTransactionForOfflineReturnReference?: boolean, invoiceNumber?: string, workstationNumber?: number, orderReference?: IOrderReferenceInfo, originalTradeType?: string, storeName?: string, fiscalTransactionNumber?: string, fiscalTypeCode?: string, invoiceSequenceNumber?: number, invoiceFiscalTransactionNumber?: string, invoiceTransactionNumber?: number, orderFulfillmentType?: string, transactionTotal?: IMoney, originalPromotionCoupons?: IOriginalPromotionCouponInfo[], originalReceiptCategory?: ReceiptCategory, fiscalTransactionStartDateTime?: string, fiscalTransactionEndDateTime?: string, fiscalSignature?: IFiscalSignature, timezoneOffsetInMinutes?: number);
+    protected newTransactionLine(): TransactionReferenceLine;
+}
+export declare function isTransactionReferenceLine(transactionLine: ITransactionLine): transactionLine is TransactionReferenceLine;

package/lib/domain/model/TransactionReferenceLine.js

@@ -0,0 +1,323 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const moment = require("moment");
+const scp_types_commerce_transaction_1 = require("@aptos-scp/scp-types-commerce-transaction");
+const BaseTransactionLine_1 = require("./BaseTransactionLine");
+const Constants_1 = require("./Constants");
+const receipt_1 = require("./receipt");
+exports.TRANSACTION_REFERENCE_LINE_TYPE = "TransactionReference";
+exports.START_POST_VOID_TRANSACTION_LINE_TYPE = "StartPostVoid";
+class TransactionReferenceLine extends BaseTransactionLine_1.BaseTransactionLine {
+    constructor(lineNumber, lineType, tenantId, retailLocationId, deviceId, businessDayDate, transactionNumber, transactionId, transactionStartDateTime, transactionEndDateTime, transactionType, inputSource, closingState, zReportNumber, fiscalId, fiscalYReceiptNumber, printerSerialNumber, referenceNumber, isTransactionForReturnReference, fiscalReceiptDate, taxLotteryCustomerCode, isTransactionForOfflineReturnReference, invoiceNumber, workstationNumber, orderReference, originalTradeType, storeName, fiscalTransactionNumber, fiscalTypeCode, invoiceSequenceNumber, invoiceFiscalTransactionNumber, invoiceTransactionNumber, orderFulfillmentType, transactionTotal, originalPromotionCoupons, originalReceiptCategory, fiscalTransactionStartDateTime, fiscalTransactionEndDateTime, fiscalSignature, timezoneOffsetInMinutes) {
+        super(lineNumber, lineType);
+        this._tenantId = tenantId;
+        this._zReportNumber = zReportNumber;
+        this._fiscalId = fiscalId;
+        this._fiscalYReceiptNumber = fiscalYReceiptNumber;
+        this._printerSerialNumber = printerSerialNumber;
+        this._fiscalReceiptDate = fiscalReceiptDate;
+        this._retailLocationId = retailLocationId;
+        this._deviceId = deviceId;
+        this._businessDayDate = businessDayDate;
+        this._transactionNumber = transactionNumber;
+        this._transactionId = transactionId;
+        this._transactionStartDateTime = transactionStartDateTime;
+        this._transactionEndDateTime = transactionEndDateTime;
+        this._transactionType = transactionType;
+        this._inputSource = inputSource;
+        this._closingState = closingState;
+        this._referenceNumber = referenceNumber;
+        this._isTransactionForReturnReference = isTransactionForReturnReference;
+        this._isTransactionForOfflineReturnReference = isTransactionForOfflineReturnReference;
+        this._taxLotteryCustomerCode = taxLotteryCustomerCode;
+        this._invoiceNumber = invoiceNumber;
+        this._workstationNumber = workstationNumber;
+        this._orderReference = orderReference;
+        this._originalPromotionCoupons = originalPromotionCoupons;
+        this._originalTradeType = originalTradeType;
+        this._storeName = storeName;
+        this._fiscalTransactionNumber = fiscalTransactionNumber;
+        this._fiscalTypeCode = fiscalTypeCode;
+        this._fiscalTransactionStartDateTime = fiscalTransactionStartDateTime;
+        this._fiscalTransactionEndDateTime = fiscalTransactionEndDateTime;
+        this._fiscalSignature = fiscalSignature;
+        this._invoiceSequenceNumber = invoiceSequenceNumber;
+        this._invoiceFiscalTransactionNumber = invoiceFiscalTransactionNumber;
+        this._invoiceTransactionNumber = invoiceTransactionNumber;
+        this._orderFulfillmentType = orderFulfillmentType;
+        this._transactionTotal = transactionTotal;
+        this._originalReceiptCategory = originalReceiptCategory;
+        this._timezoneOffsetInMinutes = timezoneOffsetInMinutes;
+    }
+    /**
+     * 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:
+     *                                                   <ul>
+     *                                                   <li>tenantId</li>
+     *                                                   <li>retailLocationId</li>
+     *                                                   <li>deviceId</li>
+     *                                                   <li>businessDayDate</li>
+     *                                                   <li>transactionNumber</li>
+     *                                                   <li>transactionId</li>
+     *                                                   </ul>
+     *
+     * @return {TenderLine}
+     */
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        var _a, _b, _c;
+        const tenantId = collectedData.get("tenantId");
+        let zReportNumber;
+        let fiscalId;
+        let fiscalYReceiptNumber;
+        let printerSerialNumber;
+        let fiscalReceiptDate;
+        let taxLotteryCustomerCode;
+        let invoiceNumber;
+        let orderFulfillmentType;
+        const retailLocationId = collectedData.get("retailLocationId");
+        const deviceId = collectedData.get("deviceId");
+        const businessDayDate = collectedData.get("businessDayDate");
+        const transactionNumber = collectedData.get("transactionNumber");
+        const originalTradeType = collectedData.get("originalTradeType");
+        const fiscalTransactionNumber = collectedData.get(Constants_1.CollectedDataKey.FiscalTransactionNumber);
+        const fiscalTypeCode = collectedData.get(Constants_1.CollectedDataKey.FiscalTypeCode);
+        const fiscalTransactionStartDateTime = collectedData.get(Constants_1.CollectedDataKey.FiscalTransactionStartDateTime);
+        const fiscalTransactionEndDateTime = collectedData.get(Constants_1.CollectedDataKey.FiscalTransactionEndDateTime);
+        const fiscalSignature = collectedData.get(Constants_1.CollectedDataKey.FiscalSignature);
+        const invoiceFiscalTransactionNumber = collectedData.get(Constants_1.CollectedDataKey.InvoiceFiscalTransactionNumber);
+        const invoiceTransactionNumber = collectedData.get(Constants_1.CollectedDataKey.InvoiceTransactionNumber);
+        const transactionId = collectedData.get("transactionId");
+        let date = collectedData.get("transactionStartDateTime");
+        const transactionStartDateTime = date && new Date(date);
+        date = collectedData.get("transactionEndDateTime");
+        const transactionEndDateTime = date && new Date(date);
+        const transactionType = collectedData.get("transactionType");
+        const inputSource = collectedData.get("inputSource");
+        const closingState = collectedData.get("closingState");
+        const referenceNumber = collectedData.get("referenceNumber");
+        const isTransactionForReturnReference = collectedData.get(Constants_1.CollectedDataKey.IsTransactionForReturnReference);
+        const isTransactionForOfflineReturnReference = collectedData.get(Constants_1.CollectedDataKey.IsTransactionForOfflineReturnReference);
+        const workstationNumber = collectedData.get("workstationNumber");
+        const orderReference = collectedData.get(Constants_1.CollectedDataKey.OrderReference);
+        const originalPromotionCoupons = collectedData.get(Constants_1.CollectedDataKey.OriginalPromotionCoupons);
+        const historicalTransactionWithAdditionalData = collectedData.get(Constants_1.CollectedDataKey.HistoricalTransactionWithAdditionalData);
+        const storeName = collectedData.get("storeName");
+        let retrievedTransaction = undefined;
+        if (uiBusinessEvent.findInput("input_retrievedTransaction")) {
+            retrievedTransaction = uiBusinessEvent.findInput("input_retrievedTransaction").inputValue;
+        }
+        else if (historicalTransactionWithAdditionalData && ((_a = historicalTransactionWithAdditionalData) === null || _a === void 0 ? void 0 : _a.transaction) && ((_b = historicalTransactionWithAdditionalData.transaction) === null || _b === void 0 ? void 0 : _b.order)) {
+            retrievedTransaction = historicalTransactionWithAdditionalData.transaction;
+        }
+        if (retrievedTransaction) {
+            const transactionLine = retrievedTransaction.lines;
+            orderFulfillmentType =
+                retrievedTransaction.order &&
+                    retrievedTransaction.order.fulfillmentGroups && ((_c = retrievedTransaction.order.fulfillmentGroups.find((fulfillment) => fulfillment.fulfillmentType === scp_types_commerce_transaction_1.FulfillmentType.shipToStore ||
+                    fulfillment.fulfillmentType === scp_types_commerce_transaction_1.FulfillmentType.shipToCustomer)) === null || _c === void 0 ? void 0 : _c.fulfillmentType);
+            const fiscalLine = transactionLine.find((line) => receipt_1.isReceiptStatusLine(line) && line.zReportNumber && line.fiscalYReceiptNumber);
+            if (fiscalLine) {
+                zReportNumber = fiscalLine.zReportNumber;
+                fiscalId = fiscalLine.fiscalId;
+                fiscalYReceiptNumber = fiscalLine.fiscalYReceiptNumber;
+                printerSerialNumber = fiscalLine.printerSerialNumber;
+                // To support the fiscal receipt date which is saved in DD/MM/YYYY format in the internal transaction
+                fiscalReceiptDate =
+                    (fiscalLine.fiscalReceiptDate && moment(fiscalLine.fiscalReceiptDate, "DD/MM/YYYY", true).isValid()
+                        ? moment(fiscalLine.fiscalReceiptDate, "DD/MM/YYYY").format("YYYY-MM-DD")
+                        : fiscalLine.fiscalReceiptDate) || businessDayDate;
+            }
+            taxLotteryCustomerCode = retrievedTransaction.taxLotteryCustomerCode;
+            invoiceNumber = retrievedTransaction.invoiceNumber || retrievedTransaction.taxInvoiceNumber;
+        }
+        const invoiceSequenceNumber = collectedData.get(Constants_1.CollectedDataKey.InvoiceSequenceNumber);
+        const transactionTotal = collectedData.get(Constants_1.CollectedDataKey.TransactionTotal);
+        const originalReceiptCategory = collectedData.get(Constants_1.CollectedDataKey.OriginalReceiptCategory);
+        const timezoneOffsetInMinutes = collectedData.get(Constants_1.CollectedDataKey.TimezoneOffsetInMinutes);
+        return new TransactionReferenceLine(lineNumber, lineType, tenantId, retailLocationId, deviceId, businessDayDate, transactionNumber, transactionId, transactionStartDateTime, transactionEndDateTime, transactionType, inputSource, closingState, zReportNumber, fiscalId, fiscalYReceiptNumber, printerSerialNumber, referenceNumber, isTransactionForReturnReference, fiscalReceiptDate, taxLotteryCustomerCode, isTransactionForOfflineReturnReference, invoiceNumber, workstationNumber, orderReference, originalTradeType, storeName, fiscalTransactionNumber, fiscalTypeCode, invoiceSequenceNumber, invoiceFiscalTransactionNumber, invoiceTransactionNumber, orderFulfillmentType, transactionTotal, originalPromotionCoupons, originalReceiptCategory, fiscalTransactionStartDateTime, fiscalTransactionEndDateTime, fiscalSignature, timezoneOffsetInMinutes);
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const tenantId = transactionLineJsonObj._tenantId;
+        const zReportNumber = transactionLineJsonObj._zReportNumber;
+        const fiscalId = transactionLineJsonObj._fiscalId;
+        const fiscalYReceiptNumber = transactionLineJsonObj._fiscalYReceiptNumber;
+        const printerSerialNumber = transactionLineJsonObj._printerSerialNumber;
+        const fiscalReceiptDate = transactionLineJsonObj._fiscalReceiptDate;
+        const referenceNumber = transactionLineJsonObj._referenceNumber;
+        const retailLocationId = transactionLineJsonObj._retailLocationId;
+        const deviceId = transactionLineJsonObj._deviceId;
+        const businessDayDate = transactionLineJsonObj._businessDayDate;
+        const transactionNumber = transactionLineJsonObj._transactionNumber;
+        const transactionId = transactionLineJsonObj._transactionId;
+        const originalTradeType = transactionLineJsonObj._originalTradeType;
+        const fiscalTransactionNumber = transactionLineJsonObj._fiscalTransactionNumber;
+        const invoiceFiscalTransactionNumber = transactionLineJsonObj._invoiceFiscalTransactionNumber;
+        const invoiceTransactionNumber = transactionLineJsonObj._invoiceTransactionNumber;
+        const fiscalTypeCode = transactionLineJsonObj._fiscalTypeCode;
+        const fiscalTransactionStartDateTime = transactionLineJsonObj._fiscalTransactionStartDateTime;
+        const fiscalTransactionEndDateTime = transactionLineJsonObj._fiscalTransactionEndDateTime;
+        const fiscalSignature = transactionLineJsonObj._fiscalSignature;
+        const orderFulfillmentType = transactionLineJsonObj._orderFulfillmentType;
+        const transactionTotal = transactionLineJsonObj._transactionTotal;
+        const originalReceiptCategory = transactionLineJsonObj._originalReceiptCategory;
+        const timezoneOffsetInMinutes = transactionLineJsonObj._timezoneOffsetInMinutes;
+        let transactionStartDateTime;
+        if (transactionLineJsonObj._transactionStartDateTime) {
+            transactionStartDateTime = new Date(transactionLineJsonObj._transactionStartDateTime);
+        }
+        let transactionEndDateTime;
+        if (transactionLineJsonObj._transactionEndDateTime) {
+            transactionEndDateTime = new Date(transactionLineJsonObj._transactionEndDateTime);
+        }
+        const transactionType = transactionLineJsonObj._transactionType;
+        const inputSource = transactionLineJsonObj._inputSource;
+        const closingState = transactionLineJsonObj._closingState;
+        const isTransactionForReturnReference = transactionLineJsonObj._isTransactionForReturnReference;
+        const isTransactionForOfflineReturnReference = transactionLineJsonObj._isTransactionForOfflineReturnReference;
+        const taxLotteryCustomerCode = transactionLineJsonObj._taxLotteryCustomerCode;
+        const invoiceNumber = transactionLineJsonObj._invoiceNumber;
+        const workstationNumber = transactionLineJsonObj._workstationNumber;
+        const orderReference = transactionLineJsonObj._orderReference;
+        const originalPromotionCoupons = transactionLineJsonObj._originalPromotionCoupons;
+        const storeName = transactionLineJsonObj._storeName;
+        const invoiceSequenceNumber = transactionLineJsonObj._invoiceSequenceNumber;
+        const transactionReferenceLine = new TransactionReferenceLine(lineNumber, lineType, tenantId, retailLocationId, deviceId, businessDayDate, transactionNumber, transactionId, transactionStartDateTime, transactionEndDateTime, transactionType, inputSource, closingState, zReportNumber, fiscalId, fiscalYReceiptNumber, printerSerialNumber, referenceNumber, isTransactionForReturnReference, fiscalReceiptDate, taxLotteryCustomerCode, isTransactionForOfflineReturnReference, invoiceNumber, workstationNumber, orderReference, originalTradeType, storeName, fiscalTransactionNumber, fiscalTypeCode, invoiceSequenceNumber, invoiceFiscalTransactionNumber, invoiceTransactionNumber, orderFulfillmentType, transactionTotal, originalPromotionCoupons, originalReceiptCategory, fiscalTransactionStartDateTime, fiscalTransactionEndDateTime, fiscalSignature, timezoneOffsetInMinutes);
+        transactionReferenceLine.loadFromJsonObject(transactionLineJsonObj);
+        return transactionReferenceLine;
+    }
+    get couldAffectPricing() {
+        return false;
+    }
+    get tenantId() {
+        return this._tenantId;
+    }
+    get printerSerialNumber() {
+        return this._printerSerialNumber;
+    }
+    get fiscalReceiptDate() {
+        return this._fiscalReceiptDate;
+    }
+    get referenceNumber() {
+        return this._referenceNumber;
+    }
+    get originalTradeType() {
+        return this._originalTradeType;
+    }
+    get fiscalTransactionNumber() {
+        return this._fiscalTransactionNumber;
+    }
+    get invoiceFiscalTransactionNumber() {
+        return this._invoiceFiscalTransactionNumber;
+    }
+    get invoiceTransactionNumber() {
+        return this._invoiceTransactionNumber;
+    }
+    get fiscalTypeCode() {
+        return this._fiscalTypeCode;
+    }
+    get fiscalTransactionStartDateTime() {
+        return this._fiscalTransactionStartDateTime;
+    }
+    get fiscalTransactionEndDateTime() {
+        return this._fiscalTransactionEndDateTime;
+    }
+    get fiscalSignature() {
+        return this._fiscalSignature;
+    }
+    get storeName() {
+        return this._storeName;
+    }
+    get zReportNumber() {
+        return this._zReportNumber;
+    }
+    get orderFulfillmentType() {
+        return this._orderFulfillmentType;
+    }
+    get transactionTotal() {
+        return this._transactionTotal;
+    }
+    get originalReceiptCategory() {
+        return this._originalReceiptCategory;
+    }
+    get fiscalId() {
+        return this._fiscalId;
+    }
+    get fiscalYReceiptNumber() {
+        return this._fiscalYReceiptNumber;
+    }
+    get retailLocationId() {
+        return this._retailLocationId;
+    }
+    get deviceId() {
+        return this._deviceId;
+    }
+    get businessDayDate() {
+        return this._businessDayDate;
+    }
+    get transactionNumber() {
+        return this._transactionNumber;
+    }
+    get transactionId() {
+        return this._transactionId;
+    }
+    get transactionStartDateTime() {
+        return this._transactionStartDateTime;
+    }
+    get transactionEndDateTime() {
+        return this._transactionEndDateTime;
+    }
+    get transactionType() {
+        return this._transactionType;
+    }
+    get timezoneOffsetInMinutes() {
+        return this._timezoneOffsetInMinutes;
+    }
+    get inputSource() {
+        return this._inputSource;
+    }
+    get closingState() {
+        return this._closingState;
+    }
+    get isTransactionForReturnReference() {
+        return this._isTransactionForReturnReference;
+    }
+    get isTransactionForOfflineReturnReference() {
+        return this._isTransactionForOfflineReturnReference;
+    }
+    get taxLotteryCustomerCode() {
+        return this._taxLotteryCustomerCode;
+    }
+    get invoiceNumber() {
+        return this._invoiceNumber;
+    }
+    get invoiceSequenceNumber() {
+        return this._invoiceSequenceNumber;
+    }
+    get workstationNumber() {
+        return this._workstationNumber;
+    }
+    get orderReference() {
+        return this._orderReference;
+    }
+    get originalPromotionCoupons() {
+        return this._originalPromotionCoupons;
+    }
+    newTransactionLine() {
+        return new TransactionReferenceLine(this.lineNumber, this.lineType, this._tenantId, this._retailLocationId, this._deviceId, this._businessDayDate, this._transactionNumber, this._transactionId, this._transactionStartDateTime, this._transactionEndDateTime, this._transactionType, this._inputSource, this._closingState, this._zReportNumber, this._fiscalId, this._fiscalYReceiptNumber, this._printerSerialNumber, this._referenceNumber, this._isTransactionForReturnReference, this._fiscalReceiptDate, this._taxLotteryCustomerCode, this._isTransactionForOfflineReturnReference, this._invoiceNumber, this._workstationNumber, this._orderReference, this._originalTradeType, this._storeName, this._fiscalTransactionNumber, this._fiscalTypeCode, this._invoiceSequenceNumber, this._invoiceFiscalTransactionNumber, this._invoiceTransactionNumber, this._orderFulfillmentType, this._transactionTotal, this._originalPromotionCoupons, this._originalReceiptCategory, this._fiscalTransactionStartDateTime, this._fiscalTransactionEndDateTime, this.fiscalSignature, this._timezoneOffsetInMinutes);
+    }
+}
+exports.TransactionReferenceLine = TransactionReferenceLine;
+function isTransactionReferenceLine(transactionLine) {
+    return (transactionLine instanceof TransactionReferenceLine ||
+        transactionLine.lineType === exports.TRANSACTION_REFERENCE_LINE_TYPE ||
+        transactionLine.lineType === exports.START_POST_VOID_TRANSACTION_LINE_TYPE);
+}
+exports.isTransactionReferenceLine = isTransactionReferenceLine;
+//# sourceMappingURL=TransactionReferenceLine.js.map

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

@@ -0,0 +1,115 @@
+import { IRetailLocationRole, ISecurityRole, IUser, RetailLocationIdentity } from "@aptos-scp/scp-component-store-selling-core";
+import { UserAttribute } from "@aptos-scp/scp-component-user";
+import { AccountStatusType } from "@aptos-scp/scp-component-user";
+export declare const USER = "User";
+export declare const PASSWORD_EXPIRING_SOON = "passwordExpiringSoon";
+export declare const LOG_OFF_TYPE = "LogOffType";
+export declare const AUTO_LOG_OFF_TYPE = "autoLogOff";
+export declare const ENTER_ATTENDANT_MODE_LINE_TYPE = "EnterAttendantMode";
+export declare const EXIT_ATTENDANT_MODE_LINE_TYPE = "ExitAttendantMode";
+export interface IUserUpdateResult {
+    isSuccessful: boolean;
+    user?: User;
+}
+export declare class SecurityRole implements ISecurityRole {
+    private _id;
+    private _securityRoleId;
+    private _name;
+    private _description?;
+    private _securityLevel?;
+    static createFromJsonObject(jsonObject: any): SecurityRole;
+    /**
+     * Construct a new Security Role object to be used to exchange the information
+     * with the server.
+     *
+     * @param id The id
+     * @param securityRoleId The role Id
+     * @param name The name
+     * @param description The description
+     */
+    constructor(id: string, securityRoleId: string, name: string, description?: string, securityLevel?: string);
+    get id(): string;
+    get securityRoleId(): string;
+    get name(): string;
+    get description(): string;
+    get securityLevel(): string;
+}
+export declare class RetailLocationRole implements IRetailLocationRole {
+    private _id;
+    private _retailLocationId;
+    private _securityRole;
+    private _assignmentStatus?;
+    private _effectiveDate?;
+    private _expirationDate?;
+    static createFromJsonObject(jsonObject: any): RetailLocationRole;
+    /**
+     * Construct a new Retail Location Role object to be used to exchange the information
+     * with the server.
+     *
+     * @param id The id
+     * @param retailLocationId The retail location Id
+     * @param securityRole The security role
+     * @param assignmentStatus The current status
+     * @param effectiveDate The effective date
+     * @param expirationDate The expiration date
+     */
+    constructor(id: string, retailLocationId: string, securityRole: ISecurityRole, assignmentStatus?: string, effectiveDate?: Date, expirationDate?: Date);
+    get id(): string;
+    get retailLocationId(): string;
+    get securityRole(): ISecurityRole;
+    get assignmentStatus(): string;
+    get effectiveDate(): Date;
+    get expirationDate(): Date;
+}
+export declare class User implements IUser {
+    private _id;
+    private _username;
+    private _firstName;
+    private _middleName?;
+    private _preferredLanguage?;
+    private _lastName;
+    private _displayName;
+    private _securityRole?;
+    private _retailLocationRole?;
+    private _accountStatus?;
+    private _passwordLastChanged?;
+    private _effectiveDate?;
+    private _expirationDate?;
+    private _shortName?;
+    static createFromJsonObject(userFromJson: any): User;
+    static buildUser(retailLocationIdentity: RetailLocationIdentity, user: UserAttribute): User;
+    static buildUserDisplayName(user: UserAttribute): string;
+    /**
+     * Construct a new User object to be used to exchange the information
+     * with the server.
+     *
+     * @param id The id
+     * @param username The username
+     * @param displayName The display name
+     * @param firstName The user's first name
+     * @param lastName The user's last name
+     * @param middleName The user's middle name
+     * @param preferredLanguage The user's middle name
+     * @param securityRole The security role
+     * @param retailLocationRole The retail location security role
+     * @param passwordLastChanged The date the password was last changed
+     * @param effectiveDate The effective date
+     * @param expirationDate The expiration date
+     * @param shortName The user's short name
+     */
+    constructor(id: string, username: string, displayName: string, firstName?: string, lastName?: string, middleName?: string, preferredLanguage?: string, securityRole?: ISecurityRole, retailLocationRole?: IRetailLocationRole, accountStatus?: AccountStatusType, passwordLastChanged?: Date, effectiveDate?: Date, expirationDate?: Date, shortName?: string);
+    get id(): string;
+    get username(): string;
+    get firstName(): string;
+    get middleName(): string;
+    get preferredLanguage(): string;
+    get lastName(): string;
+    get displayName(): string;
+    get shortName(): string;
+    get securityRole(): ISecurityRole;
+    get retailLocationRole(): IRetailLocationRole;
+    get accountStatus(): AccountStatusType;
+    get passwordLastChanged(): Date;
+    get effectiveDate(): Date;
+    get expirationDate(): Date;
+}