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

package/lib/domain/model/item/ItemLine.d.ts

@@ -0,0 +1,303 @@
+import { Money, Price, Quantity } from "@aptos-scp/scp-component-business-core";
+import { ICopyableLine } from "@aptos-scp/scp-component-store-selling-core/lib/domain/model/ICopyableLine";
+import { IExtendedAmountMaintainer, ITransactionLine, IUser, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { IAppliedTax } from "@aptos-scp/scp-component-taxation";
+import { IAuthorizationResponse } from "@aptos-scp/scp-types-commerce-devices";
+import { ActionType, ISameTransactionLineReference, ISubline as IPostableSubline, ITaxByTaxRule, ITaxExempt, ITaxOverride, ITaxOverrideDetails, ItemType, ITransactionLineReferenceType, SourceIndicator, UnitPriceSourceIndicator, IPriceChange, IReason } from "@aptos-scp/scp-types-commerce-transaction";
+import { ISublinePricingAdjustmentWithSource } from "./ISerializedPriceCalculationResultsWithSource";
+import { ItemTaxExemptLine, TransactionTaxExemptLine } from "../../model/taxExempt";
+import { BaseTransactionLine } from "../BaseTransactionLine";
+import { SecurityAuthorizationStatusType, VoidSource } from "../Constants";
+import { Customer } from "../Customer";
+import { IEmployee } from "../Employee";
+import { IExtensibilityForm } from "../extensibilityForm/IExtensibilityForm";
+import { IItemPriceSource, ItemLookupKey, SelectedUnitPrice, StoreItem } from "../StoreItem";
+import { TaxOverrideLine } from "../taxOverride/TaxOverrideLine";
+import { TenderType } from "../TenderType";
+import { IVoidableLine } from "../VoidInterfaces";
+import { IAddionalItemInfo, IItemLine, IItemSubline, IOriginalCompetitivePriceInformation, IOriginalLoyaltyInformation, IOriginalSupervisorOverrideInformation, IReturnReason, ITransactionLineTaxes } from "./IItemLine";
+export declare const ITEM_SALE_LINE_TYPE: string;
+export declare const ITEM_RETURN_LINE_TYPE: string;
+export declare const ITEM_ORDER_LINE_TYPE: string;
+export declare const ITEM_CANCEL_LINE_TYPE: string;
+export declare class ItemLine extends BaseTransactionLine implements IItemLine, IVoidableLine, IExtendedAmountMaintainer, ICopyableLine {
+    private _enteredLookupKey;
+    private _itemLookupKeys;
+    private _item;
+    private _taxGroupId;
+    private _unitPrice;
+    private _quantity;
+    private _extendedAmountAdjustment;
+    private _lineSavings;
+    private _annotationDescription;
+    private _manuallyEnteredPrice;
+    private _taxByAuthority;
+    private _taxExemptDisplayName;
+    private _totalLineTax;
+    private _sublines;
+    private _accountingCurrency;
+    private _additionalItemInfo;
+    private _salesperson;
+    private _manufacturerSuggestedPrice;
+    private _unitCost;
+    private _itemType;
+    private _authResponse;
+    private _actionType;
+    private _authorizationDeviceId;
+    private _tenderType;
+    private _taxExempt;
+    private _preTaxExemptDetails?;
+    private _preferredDisplayKeyType;
+    private _pointsEligible;
+    private _unitPriceSourceIndicator;
+    private _inputSource;
+    private _returnReason;
+    private _securityAuthorizationStatus;
+    private _supervisorOverrideLineReference;
+    private _originalTransactionLineReference;
+    private _originalTransactionNumber;
+    private _comments;
+    private _isFastDiscountItem;
+    private _fulfillmentGroupId;
+    private _sendSale;
+    private _subscribed;
+    private _subscriptionQuantity;
+    private _lineNumberFromReturnTransaction?;
+    private _sublineIndexFromReturnItem?;
+    private _taxOverride?;
+    private _preTaxOverrideDetails?;
+    private _subLineFromReturnItem?;
+    private _lineNumberFromReturnCanonicalTransaction?;
+    private _lineNumberFromReturnCanonicalSubItem?;
+    private _returnable?;
+    private _originalUnitPriceFromExternalItem?;
+    private _originalTransactionPerformingUser?;
+    private _originalCustomer?;
+    private _originalTransactionSalesperson?;
+    private _eligibleForSubscription?;
+    private _eligibleForSendSale?;
+    private _defaultReturnPrice?;
+    private _orderLineReference?;
+    private _lineNumberFromOrder?;
+    private _itemPermanentPrice?;
+    private _itemPermanentPriceSource?;
+    private _itemTemporaryPrice?;
+    private _itemTemporaryPriceSource?;
+    private _itemFullPrice?;
+    private _itemFullPriceSource?;
+    private _itemEmployeeDiscountPercent?;
+    private _itemSelectedUnitPrice?;
+    private _subscriptionFrequencyCodes?;
+    private _pricingCalculationSourceIndicator?;
+    private _taxationCalculationSourceIndicator?;
+    private _pricingDataSourceIndicator?;
+    private _taxationDataSourceIndicator?;
+    private _extensibilityFormData?;
+    private _markeddownPriceLineSavings?;
+    private _originalEmployeeCustomer;
+    private _prepaidAmount?;
+    private _prepaidTaxAmount?;
+    private _prepaidSavingsAmount?;
+    private _originalPriceOverride?;
+    private _originalLoyaltyInformation?;
+    private _originalCompetitivePriceInformation?;
+    private _originalSupervisorOverrideInformation?;
+    private _originalTaxOverride?;
+    private _originalComments?;
+    private _extendedRegularAmount?;
+    private _originalRedemptionLoyaltyTransactionKeys?;
+    private _originalSaleLoyaltyTransactionKeys?;
+    private _originalDiscountReason?;
+    /**
+     * 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 {ItemLine}
+     */
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): ItemLine;
+    static getLineSavingsAmount(itemLine: ItemLine, sublineFromExternalItem: IPostableSubline, accountingCurrency: string): Money;
+    static createFromJsonObject(transactionLineJsonObj: any): ItemLine;
+    get accountingCurrency(): string;
+    get couldAffectPricing(): boolean;
+    get couldAffectTaxation(): boolean;
+    get enteredLookupKey(): ItemLookupKey;
+    get itemLookupKeys(): ItemLookupKey[];
+    get preferredDisplayKeyType(): string;
+    get item(): StoreItem;
+    get itemType(): ItemType;
+    get originalTaxGroupId(): string;
+    get taxGroupId(): string;
+    get originalUnitPrice(): Price;
+    /**
+     * Since this is the primary item line, we cannot have a price change.  As such, this could return the unit price,
+     * but that would suggest that there was a price override.  Instead this returns undefined to indicate that there was
+     * no price override.
+     *
+     * @return {Price}
+     */
+    get unitPriceBeforePriceOverride(): Price;
+    get unitPrice(): Price;
+    get unitPriceExcludingTransactionDiscounts(): Price;
+    get originalQuantity(): Quantity;
+    get quantity(): Quantity;
+    get extendedAmountExcludingTransactionDiscounts(): Money;
+    get originalExtendedAmount(): Money;
+    get extendedAmountAdjustment(): Money;
+    get originalLineSavings(): Money;
+    get lineSavings(): Money;
+    get extendedRegularAmount(): Money;
+    get annotationDescription(): string;
+    get manuallyEnteredPrice(): boolean;
+    get taxByAuthority(): IAppliedTax[];
+    get taxExemptDisplayName(): string;
+    get totalLineTax(): Money;
+    get additionalItemInfo(): IAddionalItemInfo;
+    get sublines(): IItemSubline[];
+    /**
+     * Since this is the primary item line, it cannot be voided.  As such, this could return the taxByAuthority,
+     * but that would suggest that there was a void.  Instead this returns undefined to indicate that there was
+     * no void.
+     *
+     * @return {Price}
+     */
+    get taxByAuthorityBeforeVoid(): IAppliedTax[];
+    /**
+     * Since this is the primary item line, it cannot be voided.  As such, this could return the totalLineTax,
+     * but that would suggest that there was a void.  Instead this returns undefined to indicate that there was
+     * no void.
+     *
+     * @return {Price}
+     */
+    get totalLineTaxBeforeVoid(): Money;
+    get voided(): boolean;
+    get giftReceipt(): boolean;
+    get comments(): string[];
+    get voidSource(): VoidSource;
+    get salesperson(): IEmployee;
+    get taxExempt(): ITaxExempt;
+    get preTaxExemptDetails(): IAppliedTax[];
+    get taxOverride(): ITaxOverride;
+    get preTaxOverrideDetails(): ITaxByTaxRule[];
+    get authResponse(): IAuthorizationResponse;
+    get authorizationDeviceId(): string;
+    get isAuthorized(): boolean;
+    get tenderId(): string;
+    get tenderName(): string;
+    get actionType(): ActionType;
+    get tenderType(): TenderType;
+    get manufacturerSuggestedPrice(): Price;
+    get unitCost(): Money;
+    get preventsTransactionVoid(): boolean;
+    get allowVoid(): boolean;
+    get pointsEligible(): string[];
+    get unitPriceSourceIndicator(): UnitPriceSourceIndicator;
+    get inputSource(): string;
+    get returnReason(): IReturnReason;
+    get securityAuthorizationStatus(): SecurityAuthorizationStatusType;
+    get isFastDiscountItem(): boolean;
+    get markeddownPriceLineSavings(): Money;
+    get supervisorOverrideLineReference(): ITransactionLineReferenceType;
+    get originalTransactionLineReference(): ITransactionLineReferenceType;
+    get originalTransactionNumber(): string;
+    get lineNumberFromReturnTransaction(): number;
+    get sublineIndexFromReturnItem(): number;
+    get fulfillmentGroupId(): number;
+    get sendSale(): boolean;
+    get subscribed(): boolean;
+    get subscriptionQuantity(): number;
+    get subLineFromReturnItem(): IPostableSubline;
+    get lineNumberFromReturnCanonicalTransaction(): number;
+    get lineNumberFromReturnCanonicalSubItem(): number;
+    get returnable(): boolean;
+    get originalUnitPriceFromExternalItem(): Price;
+    get defaultReturnPrice(): Price;
+    get originalTransactionPerformingUser(): IUser;
+    get originalCustomer(): Customer;
+    get originalTransactionSalesperson(): IEmployee;
+    get originalEmployeeCustomer(): IEmployee;
+    get originalPriceOverride(): IPriceChange;
+    get originalDiscountReason(): IReason;
+    get originalLoyaltyInformation(): IOriginalLoyaltyInformation[];
+    get originalRedemptionLoyaltyTransactionKeys(): string[];
+    get originalSaleLoyaltyTransactionKeys(): string[];
+    get originalCompetitivePriceInformation(): IOriginalCompetitivePriceInformation;
+    get originalSupervisorOverrideInformation(): IOriginalSupervisorOverrideInformation[];
+    get originalComments(): string[];
+    get originalTaxOverride(): ITaxOverrideDetails;
+    get originalAdjustments(): ISublinePricingAdjustmentWithSource[];
+    get eligibleForSubscription(): boolean;
+    get eligibleForSendSale(): boolean;
+    get reservedQuantity(): number;
+    get reservationId(): string;
+    get itemReservationCode(): string;
+    get orderLineReference(): ITransactionLineReferenceType;
+    get lineNumberFromOrder(): number;
+    get itemPermanentPrice(): Price;
+    get itemPermanentPriceSource(): IItemPriceSource;
+    get itemTemporaryPrice(): Price;
+    get itemTemporaryPriceSource(): IItemPriceSource;
+    get itemFullPrice(): Price;
+    get itemFullPriceSource(): IItemPriceSource;
+    get itemEmployeeDiscountPercent(): string;
+    get itemSelectedUnitPrice(): SelectedUnitPrice;
+    get presentation(): IItemLine;
+    get extendedPresentationAmount(): Money;
+    get subscriptionFrequencyCodes(): string[];
+    get pricingCalculationSourceIndicator(): SourceIndicator;
+    get taxationCalculationSourceIndicator(): SourceIndicator;
+    get pricingDataSourceIndicator(): SourceIndicator;
+    get taxationDataSourceIndicator(): SourceIndicator;
+    get cancelled(): boolean;
+    get extensibilityFormData(): IExtensibilityForm[];
+    get prepaidAmount(): Money;
+    get prepaidTaxAmount(): Money;
+    get prepaidSavingsAmount(): Money;
+    get itemTaxExemptAmount(): Money;
+    get itemTaxAdjustmentAmount(): Money;
+    get extendedAmountAfterTaxAdjustment(): Money;
+    get unitPriceAfterTaxAdjustment(): Price;
+    updateExtendedAmount(amount: Money): ITransactionLine;
+    updateExtendedAmountExcludingTax(amount: Money): ITransactionLine;
+    updateExtendedAmountIncludingTax(amount: Money): ITransactionLine;
+    updateUnitPrice(price: Price, unitPriceSourceIndicator?: UnitPriceSourceIndicator): ItemLine;
+    setPricingSourceIndicator(calculationSourceIndicator?: SourceIndicator, dataSourceIndicator?: SourceIndicator): ItemLine;
+    setTaxationSourceIndicator(calculationSourceIndicator?: SourceIndicator, dataSourceIndicator?: SourceIndicator): ItemLine;
+    setTransactionLineTaxes(transactionLineTaxes: ITransactionLineTaxes, extendedAmount?: Money): IItemLine;
+    setSublines(sublines: IItemSubline[]): IItemLine;
+    setTaxExemptInformation(taxExemptLine: ItemTaxExemptLine | TransactionTaxExemptLine, preTaxExemptDetails: IAppliedTax[]): IItemLine;
+    setTaxOverrideInformation(taxOverrideLine: TaxOverrideLine, preTaxOverrideDetails: ITaxByTaxRule[]): IItemLine;
+    setSupervisorOverrideLineReference(supervisorOverrideLineReference: ITransactionLineReferenceType): IItemLine;
+    setSecurityAuthorizationStatus(value: SecurityAuthorizationStatusType): IItemLine;
+    copyLineWithNewLineNumber(newLineNumber: number): ItemLine;
+    setExtendedRegularAmount(amount?: Money): IItemLine;
+    protected constructor(lineNumber: number, lineType: string, accountingCurrency: string, lineSavings?: Money);
+    protected clone(): BaseTransactionLine;
+    protected loadFromJsonObject(transactionLineJsonObj: any): void;
+    protected newTransactionLine(): BaseTransactionLine;
+    private static determineQuantity;
+    private static getEnteredLookupKeyFromCollectedData;
+    private static getItemLookupKeyFromCollectedData;
+    private static convertLookupKeyFromCollectedData;
+    private setExtendedAmountExcludingAndIncludingTax;
+}
+export declare function makeTaxExemptLineReference(lineNumber: number): ISameTransactionLineReference;
+export declare const isItemLine: (transactionLine: ITransactionLine) => transactionLine is ItemLine;
+export declare const isSaleOrOrderLine: (transactionLine: ITransactionLine) => transactionLine is ItemLine;
+export declare const isSaleLine: (transactionLine: ITransactionLine) => transactionLine is ItemLine;
+export declare const isOrderLine: (transactionLine: ITransactionLine) => transactionLine is ItemLine;
+export declare const isSendSaleLine: (transactionLine: ITransactionLine) => transactionLine is ItemLine;
+export declare const isFulfillmentLine: (transactionLine: ITransactionLine) => transactionLine is ItemLine;
+export declare function getExtendedAmountExcludingAndIncludingTax(taxByAuthorities: IAppliedTax[], extendedAmount: Money, totalLineTax: Money): {
+    extendedAmountExcludingTax: Money;
+    extendedAmountIncludingTax: Money;
+};
+export declare function isReturnLine(transactionLine: ITransactionLine): boolean;
+export declare function isCancelLine(transactionLine: ITransactionLine): boolean;
+export declare function adjustSignForLineType(lineType: string, amount: Money): Money;
+export declare function getPriceSignAdjuster(lineType: string): number;
+export declare function isItemPickupOrDeliveryLine(line: ITransactionLine): boolean;