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

package/lib/domain/model/fee/FeeLine.d.ts

@@ -0,0 +1,179 @@
+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 { ITransactionLine, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { IAppliedTax } from "@aptos-scp/scp-component-taxation";
+import { FeeType, ISameTransactionLineReference, ITaxByTaxRule, ITaxExempt, ITaxOverride, IFeeSubline as IPostableFeeSubline, ITransactionLineReferenceType, SourceIndicator, ITaxOverrideDetails } from "@aptos-scp/scp-types-commerce-transaction";
+import { ItemTaxExemptLine, TransactionTaxExemptLine } from "../../model/taxExempt";
+import { BaseTransactionLine } from "../BaseTransactionLine";
+import { VoidSource } from "../Constants";
+import { ITransactionLineTaxes } from "../item/IItemLine";
+import { TaxOverrideLine } from "../taxOverride/TaxOverrideLine";
+import { IFeeLine, IFeeSubline, IFulfillmentGroupFee } from "./IFeeLine";
+export declare const TRANSACTION_FEE_LINE_TYPE = "TransactionFee";
+export declare const TRANSACTION_FEE_REFUND_LINE_TYPE = "TransactionFeeRefund";
+export declare const ITEM_FEE_LINE_TYPE = "ItemFee";
+export declare const ITEM_FEE_REFUND_LINE_TYPE = "ItemFeeRefund";
+export declare class FeeLine extends BaseTransactionLine implements IFeeLine, ICopyableLine {
+    protected _feeType: FeeType;
+    protected _feeId: string;
+    protected _unitPrice: Price;
+    protected _quantity: Quantity;
+    protected _customFeeType: string;
+    protected _unitAmount: Money;
+    protected _description: string;
+    protected _externalId: string;
+    protected _longDescription: string;
+    protected _departmentId: string;
+    protected _departmentGroupId: string;
+    protected _orderReferenceId: string;
+    protected _feesByFulfillmentGroup: IFulfillmentGroupFee[];
+    protected _fulfillmentGroupIds: string[];
+    protected _taxGroupId: string;
+    private _taxByAuthority;
+    private _taxExemptDisplayName;
+    private _taxExempt;
+    private _preTaxExemptDetails?;
+    private _taxOverride?;
+    private _preTaxOverrideDetails?;
+    private _taxationCalculationSourceIndicator?;
+    private _taxationDataSourceIndicator?;
+    private _pricingCalculationSourceIndicator?;
+    private _pricingDataSourceIndicator?;
+    private _totalLineTax;
+    private _feeTaxExemptAmount?;
+    private _feeTaxAdjustmentAmount?;
+    private _extendedAmountAfterTaxAdjustment?;
+    private _unitAmountAfterTaxAdjustment?;
+    private _autoApplied?;
+    private _quantityAllowed?;
+    private _itemLineReference?;
+    private _percent?;
+    private _maximumAmount?;
+    private _returnRule?;
+    private _sublines?;
+    private _sublineFromOriginalItemFee?;
+    private _originalTransactionLineReference?;
+    private _lineNumberFromReturnCanonicalTransaction?;
+    private _sublineIndexFromReturnCanonicalTransaction?;
+    private _lineNumberFromReturnTransaction?;
+    private _originalTaxOverride?;
+    /**
+     * 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 {FeeLine}
+     */
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): FeeLine;
+    static createFromJsonObject(transactionLineJsonObj: any): FeeLine;
+    get quantity(): Quantity;
+    get unitPrice(): Price;
+    /**
+     * @deprecated This will no longer be used in the future. Use the direct line instead.
+     */
+    get feesByFulfillmentGroup(): IFulfillmentGroupFee[];
+    get fulfillmentGroupIds(): string[];
+    get originalTaxOverride(): ITaxOverrideDetails;
+    get feeType(): FeeType;
+    get feeId(): string;
+    get couldAffectPricing(): boolean;
+    get couldAffectTaxation(): boolean;
+    get sublineFromOriginalItemFee(): IPostableFeeSubline;
+    get originalTransactionLineReference(): ITransactionLineReferenceType;
+    get lineNumberFromReturnCanonicalTransaction(): number;
+    get lineNumberFromReturnTransaction(): number;
+    get sublineIndexFromReturnCanonicalTransaction(): number;
+    get customFeeType(): string;
+    get unitAmount(): Money;
+    get description(): string;
+    get externalId(): string;
+    get longDescription(): string;
+    get departmentId(): string;
+    get departmentGroupId(): string;
+    get orderReferenceId(): string;
+    get voided(): boolean;
+    get voidSource(): VoidSource;
+    get preventsTransactionVoid(): boolean;
+    get allowVoid(): boolean;
+    get taxGroupId(): string;
+    get taxByAuthority(): IAppliedTax[];
+    get taxExemptDisplayName(): string;
+    get totalLineTax(): Money;
+    /**
+     * 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 {IAppliedTax}
+     */
+    get taxByAuthorityBeforeVoid(): IAppliedTax[];
+    /**
+     * 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 {Money}
+     */
+    get totalLineTaxBeforeVoid(): Money;
+    get unitAmountBeforeOverride(): Money;
+    get taxExempt(): ITaxExempt;
+    get preTaxExemptDetails(): IAppliedTax[];
+    get taxOverride(): ITaxOverride;
+    get preTaxOverrideDetails(): ITaxByTaxRule[];
+    get taxationCalculationSourceIndicator(): SourceIndicator;
+    get taxationDataSourceIndicator(): SourceIndicator;
+    get pricingCalculationSourceIndicator(): SourceIndicator;
+    get pricingDataSourceIndicator(): SourceIndicator;
+    get feeTaxExemptAmount(): Money;
+    get feeTaxAdjustmentAmount(): Money;
+    get extendedAmountAfterTaxAdjustment(): Money;
+    get unitAmountAfterTaxAdjustment(): Money;
+    get autoApplied(): boolean;
+    get quantityAllowed(): boolean;
+    get itemLineReference(): ISameTransactionLineReference;
+    get percent(): string;
+    get maximumAmount(): Money;
+    get returnRule(): string;
+    get sublines(): IFeeSubline[];
+    static feeTypeFromJsonObject(transactionLineJsonObj: any): FeeType;
+    static feeTypeFromCollectedData(collectedData: Readonly<Map<string, any>>): FeeType;
+    static taxGroupIdFromJsonObject(transactionLineJsonObj: any): string;
+    copyLineWithNewLineNumber(newLineNumber: number): FeeLine;
+    /**
+     * This method should be implemented only in decorator and not in the Fee line.
+     * @param sublines fee's sublines
+     */
+    setSublines(sublines: IFeeSubline[]): IFeeLine;
+    setItemLineReference(itemLineReference: ISameTransactionLineReference): IFeeLine;
+    setPricingSourceIndicator(calculationSourceIndicator?: SourceIndicator, dataSourceIndicator?: SourceIndicator): IFeeLine;
+    setTaxationSourceIndicator(calculationSourceIndicator?: SourceIndicator, dataSourceIndicator?: SourceIndicator): IFeeLine;
+    setTaxExemptInformation(taxExemptLine: ItemTaxExemptLine | TransactionTaxExemptLine, preTaxExemptDetails: IAppliedTax[]): IFeeLine;
+    setTaxOverrideInformation(taxOverrideLine: TaxOverrideLine, preTaxOverrideDetails: ITaxByTaxRule[]): IFeeLine;
+    setTransactionLineTaxes(transactionLineTaxes: ITransactionLineTaxes, extendedAmount?: Money): IFeeLine;
+    updateExtendedAmountExcludingTax(amount: Money): ITransactionLine;
+    updateExtendedAmountIncludingTax(amount: Money): ITransactionLine;
+    protected constructor(lineNumber: number, lineType: string, feeType: FeeType, extendedAmount?: Money, extendedAmountExcludingTax?: Money, extendedAmountIncludingTax?: Money, feeId?: string, customFeeType?: string, unitAmount?: Money, quantity?: Quantity, description?: string, externalId?: string, longDescription?: string, departmentId?: string, departmentGroupId?: string, orderReferenceId?: string, feesByFulfillmentGroup?: IFulfillmentGroupFee[], fulfillmentGroupIds?: string[], taxGroupId?: string, autoApplied?: boolean, quantityAllowed?: boolean, itemLineReference?: ISameTransactionLineReference, percent?: string, maximumAmount?: Money, returnRule?: string);
+    protected clone(): BaseTransactionLine;
+    protected newTransactionLine(): BaseTransactionLine;
+    protected loadFromJsonObject(transactionLineJsonObj: any): void;
+    protected loadTaxInformation(transactionLineJsonObj: any): void;
+    protected loadFeesByFulfillmentGroupFromJsonObject(transactionLineJsonObj: any): void;
+    protected loadFromCollectedData(collectedData: Readonly<Map<string, any>>): void;
+    protected loadFeesByFulfillmentGroupFromCollectedData(collectedData: Readonly<Map<string, any>>): void;
+    protected taxGroupIdFromCollectedData(collectedData: Readonly<Map<string, any>>): void;
+    private setExtendedAmountExcludingAndIncludingTax;
+}
+export declare function isFeeLine(transactionLine: ITransactionLine): transactionLine is FeeLine;
+export declare function isTransactionFeeLine(transactionLine: ITransactionLine): transactionLine is FeeLine;
+export declare function isTransactionFeeRefundLine(transactionLine: ITransactionLine): transactionLine is FeeLine;
+export declare function isBagFeeLine(transactionLine: ITransactionLine): transactionLine is FeeLine;
+export declare function isShippingFeeLine(transactionLine: ITransactionLine): transactionLine is FeeLine;
+export declare function isDeliveryFeeLine(transactionLine: ITransactionLine): transactionLine is FeeLine;
+export declare function isItemFeeLine(transactionLine: ITransactionLine): transactionLine is FeeLine;
+export declare function isItemFeeRefundLine(transactionLine: ITransactionLine): transactionLine is FeeLine;
+export declare function adjustSignForFeeLineType(lineType: string, amount: Money): Money;
+export declare function getFeeLinePriceSignAdjuster(lineType: string): number;