Files

Shahed Nasser 02d5c1da88 docs: update Typedoc and regenerate references (#1994 )

* generated new services reference

* changed from automatic push to automated pull request

* updated typedoc, regenerated JS Client reference

* regenerated the reference after updating typedoc

* added action for js client

2022-08-04 17:29:52 +03:00

19 KiB

Raw Blame History

Class: TotalsService

A service that calculates total and subtotals for orders, carts etc..

Implements

Hierarchy

TransactionBaseService<TotalsService>

↳ TotalsService

Constructors

constructor

• new TotalsService(__namedParameters)

Parameters

Name	Type
`__namedParameters`	`TotalsServiceProps`

Overrides

TransactionBaseService<TotalsService>.constructor

Defined in

packages/medusa/src/services/totals.ts:99

Properties

configModule

• Protected Optional Readonly configModule: Record<string, unknown>

Inherited from

TransactionBaseService.configModule

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:13

container

• Protected Readonly container: unknown

Inherited from

TransactionBaseService.container

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:12

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/totals.ts:93

taxCalculationStrategy_

• Private taxCalculationStrategy_: ITaxCalculationStrategy

Defined in

packages/medusa/src/services/totals.ts:97

taxProviderService_

• Private taxProviderService_: TaxProviderService

Defined in

packages/medusa/src/services/totals.ts:96

transactionManager_

• Protected transactionManager_: EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/totals.ts:94

Methods

atomicPhase_

▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.

Type parameters

Name
`TResult`
`TError`

Parameters

Name	Type	Description
`work`	(`transactionManager`: `EntityManager`) => `Promise`<`TResult`>	the transactional work to be done
`isolationOrErrorHandler?`	`IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`>	the isolation level to be used for the work.
`maybeErrorHandlerOrDontFail?`	(`error`: `TError`) => `Promise`<`void` \| `TResult`>	Potential error handler

Returns

Promise<TResult>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:53

calculateDiscount_

▸ calculateDiscount_(lineItem, variant, variantPrice, value, discountType): LineDiscount

Calculates either fixed or percentage discount of a variant

Parameters

Name	Type	Description
`lineItem`	`LineItem`	id of line item
`variant`	`string`	id of variant in line item
`variantPrice`	`number`	price of the variant based on region
`value`	`number`	discount value
`discountType`	`DiscountRuleType`	the type of discount (fixed or percentage)

Returns

LineDiscount

triples of lineitem, variant and applied discount

Defined in

packages/medusa/src/services/totals.ts:567

getAllocationItemDiscounts

▸ getAllocationItemDiscounts(discount, cart): LineDiscount[]

If the rule of a discount has allocation="item", then we need to calculate discount on each item in the cart. Furthermore, we need to make sure to only apply the discount on valid variants. And finally we return ether an array of percentages discounts or fixed discounts alongside the variant on which the discount was applied.

Parameters

Name	Type	Description
`discount`	`Discount`	the discount to which we do the calculation
`cart`	`Order` \| `Cart`	the cart to calculate discounts for

Returns

LineDiscount[]

array of triples of lineitem, variant and applied discount

Defined in

packages/medusa/src/services/totals.ts:609

getAllocationMap

▸ getAllocationMap(orderOrCart, options?): LineAllocationsMap

Gets a map of discounts and gift cards that apply to line items in an order. The function calculates the amount of a discount or gift card that applies to a specific line item.

Parameters

Name	Type	Description
`orderOrCart`	`Order` \| `Cart`	the order or cart to get an allocation map for
`options`	`AllocationMapOptions`	controls what should be included in allocation map

Returns

LineAllocationsMap

the allocation map for the line items in the cart or order.

Defined in

packages/medusa/src/services/totals.ts:390

getCalculationContext

▸ getCalculationContext(cartOrOrder, options?): TaxCalculationContext

Prepares the calculation context for a tax total calculation.

Parameters

Name	Type	Description
`cartOrOrder`	`Order` \| `Cart`	the cart or order to get the calculation context for
`options`	`CalculationContextOptions`	options to gather context by

Returns

TaxCalculationContext

the tax calculation context

Defined in

packages/medusa/src/services/totals.ts:972

getDiscountTotal

▸ getDiscountTotal(cartOrOrder): number

Calculates the total discount amount for each of the different supported discount types. If discounts aren't present or invalid returns 0.

Parameters

Name	Type	Description
`cartOrOrder`	`Order` \| `Cart`	the cart or order to calculate discounts for

Returns

number

the total discounts amount

Defined in

packages/medusa/src/services/totals.ts:938

getGiftCardTotal

▸ getGiftCardTotal(cartOrOrder): Object

Gets the gift card amount on a cart or order.

Parameters

Name	Type	Description
`cartOrOrder`	`Order` \| `Cart`	the cart or order to get gift card amount for

Returns

Object

the gift card amount applied to the cart or order

Name	Type
`tax_total`	`number`
`total`	`number`

Defined in

packages/medusa/src/services/totals.ts:866

getGiftCardableAmount

▸ getGiftCardableAmount(cartOrOrder): Promise<number>

Gets the amount that can be gift carded on a cart. In regions where gift cards are taxable this amount should exclude taxes.

Parameters

Name	Type	Description
`cartOrOrder`	`Order` \| `Cart`	the cart or order to get gift card amount for

Returns

Promise<number>

the gift card amount applied to the cart or order

Defined in

packages/medusa/src/services/totals.ts:851

getLineDiscounts

▸ getLineDiscounts(cartOrOrder, discount): LineDiscountAmount[]

Returns the discount amount allocated to the line items of an order.

Parameters

Name	Type	Description
`cartOrOrder`	`Order` \| `Cart`	the cart or order to get line discount allocations for
`discount`	`Discount`	the discount to use as context for the calculation

Returns

LineDiscountAmount[]

the allocations that the discount has on the items in the cart or order

Defined in

packages/medusa/src/services/totals.ts:660

getLineItemAdjustmentsTotal

▸ getLineItemAdjustmentsTotal(cartOrOrder): number

Parameters

Name	Type
`cartOrOrder`	`Order` \| `Cart`

Returns

number

Defined in

packages/medusa/src/services/totals.ts:637

getLineItemDiscountAdjustment

▸ getLineItemDiscountAdjustment(lineItem, discount): number

Parameters

Name	Type
`lineItem`	`LineItem`
`discount`	`Discount`

Returns

number

Defined in

packages/medusa/src/services/totals.ts:622

getLineItemRefund

▸ getLineItemRefund(order, lineItem): number

The amount that can be refunded for a given line item.

Parameters

Name	Type	Description
`order`	`Order`	order to use as context for the calculation
`lineItem`	`LineItem`	the line item to calculate the refund amount for.

Returns

number

the line item refund amount.

Defined in

packages/medusa/src/services/totals.ts:482

getLineItemTotal

▸ getLineItemTotal(lineItem, cartOrOrder, options?): Promise<number>

Gets a total for a line item. The total can take gift cards, discounts and taxes into account. This can be controlled through the options.

Parameters

Name	Type	Description
`lineItem`	`LineItem`	the line item to calculate a total for
`cartOrOrder`	`Order` \| `Cart`	the cart or order to use as context for the calculation
`options`	`GetLineItemTotalOptions`	the options to use for the calculation

Returns

Promise<number>

the line item total

Defined in

packages/medusa/src/services/totals.ts:820

getLineItemTotals

▸ getLineItemTotals(lineItem, cartOrOrder, options?): Promise<LineItemTotals>

Breaks down the totals related to a line item; these are the subtotal, the amount of discount applied to the line item, the amount of a gift card applied to a line item and the amount of tax applied to a line item.

Parameters

Name	Type	Description
`lineItem`	`LineItem`	the line item to calculate totals for
`cartOrOrder`	`Order` \| `Cart`	the cart or order to use as context for the calculation
`options`	`LineItemTotalsOptions`	the options to evaluate the line item totals for

Returns

Promise<LineItemTotals>

the breakdown of the line item totals

Defined in

packages/medusa/src/services/totals.ts:706

getPaidTotal

▸ getPaidTotal(order): number

Gets the total payments made on an order

Parameters

Name	Type	Description
`order`	`Order`	the order to calculate paid amount for

Returns

number

the total paid amount

Defined in

packages/medusa/src/services/totals.ts:145

getRefundTotal

▸ getRefundTotal(order, lineItems): number

Calculates refund total of line items. If any of the items to return have been discounted, we need to apply the discount again before refunding them.

Parameters

Name	Type	Description
`order`	`Order`	cart or order to calculate subtotal for
`lineItems`	`LineItem`[]	the line items to calculate refund total for

Returns

number

the calculated subtotal

Defined in

packages/medusa/src/services/totals.ts:526

getRefundedTotal

▸ getRefundedTotal(order): number

Gets the total refund amount for an order.

Parameters

Name	Type	Description
`order`	`Order`	the order to get total refund amount for.

Returns

number

the total refunded amount for an order.

Defined in

packages/medusa/src/services/totals.ts:467

getShippingMethodTotals

▸ getShippingMethodTotals(shippingMethod, cartOrOrder, opts?): Promise<ShippingMethodTotals>

Gets the totals breakdown for a shipping method. Fetches tax lines if not already provided.

Parameters

Name	Type	Description
`shippingMethod`	`ShippingMethod`	the shipping method to get totals breakdown for.
`cartOrOrder`	`Order` \| `Cart`	the cart or order to use as context for the breakdown
`opts`	`GetShippingMethodTotalsOptions`	options for what should be included

Returns

Promise<ShippingMethodTotals>

An object that breaks down the totals for the shipping method

Defined in

packages/medusa/src/services/totals.ts:179

getShippingTotal

▸ getShippingTotal(cartOrOrder): number

Calculates shipping total

Parameters

Name	Type	Description
`cartOrOrder`	`Order` \| `Cart`	cart or order to calculate subtotal for

Returns

number

shipping total

Defined in

packages/medusa/src/services/totals.ts:286

getSubtotal

▸ getSubtotal(cartOrOrder, opts?): number

Calculates subtotal of a given cart or order.

Parameters

Name	Type	Description
`cartOrOrder`	`Order` \| `Cart`	cart or order to calculate subtotal for
`opts`	`SubtotalOptions`	options

Returns

number

the calculated subtotal

Defined in

packages/medusa/src/services/totals.ts:262

getSwapTotal

▸ getSwapTotal(order): number

The total paid for swaps. May be negative in case of negative swap difference.

Parameters

Name	Type	Description
`order`	`Order`	the order to calculate swap total for

Returns

number

the swap total

Defined in

packages/medusa/src/services/totals.ts:160

getTaxTotal

▸ getTaxTotal(cartOrOrder, forceTaxes?): Promise<null | number>

Calculates tax total Currently based on the Danish tax system

Parameters

Name	Type	Default value	Description
`cartOrOrder`	`Order` \| `Cart`	`undefined`	cart or order to calculate tax total for
`forceTaxes`	`boolean`	`false`	whether taxes should be calculated regardless of region settings

Returns

Promise<null | number>

tax total

Defined in

packages/medusa/src/services/totals.ts:301

getTotal

▸ getTotal(cartOrOrder, options?): Promise<number>

Calculates subtotal of a given cart or order.

Parameters

Name	Type	Description
`cartOrOrder`	`Order` \| `Cart`	object to calculate total for
`options`	`GetTotalsOptions`	options to calculate by

Returns

Promise<number>

the calculated subtotal

Defined in

packages/medusa/src/services/totals.ts:122

rounded

▸ rounded(value): number

Rounds a number using Math.round.

Parameters

Name	Type	Description
`value`	`number`	the value to round

Returns

number

the rounded value

Defined in

packages/medusa/src/services/totals.ts:1002

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name	Type
`err`	`Record`<`string`, `unknown`> \| { `code`: `string` }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:34

withTransaction

▸ withTransaction(transactionManager?): TotalsService

Parameters

Name	Type
`transactionManager?`	`EntityManager`

Returns

TotalsService

Inherited from

TransactionBaseService.withTransaction

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:16

19 KiB Raw Blame History

Class: TotalsService

Hierarchy

Constructors

constructor

Parameters

Overrides

Defined in

Properties

configModule

Inherited from

Defined in

container

Inherited from

Defined in

manager_

Overrides

Defined in

taxCalculationStrategy_

Defined in

taxProviderService_

Defined in

transactionManager_

Overrides

Defined in

Methods

atomicPhase_

Type parameters

Parameters

Returns

Inherited from

Defined in

calculateDiscount_

Parameters

Returns

Defined in

getAllocationItemDiscounts

Parameters

Returns

Defined in

getAllocationMap

Parameters

Returns

Defined in

getCalculationContext

Parameters

Returns

Defined in

getDiscountTotal

Parameters

Returns

Defined in

getGiftCardTotal

Parameters

Returns

Defined in

getGiftCardableAmount

Parameters

Returns

Defined in

getLineDiscounts

Parameters

Returns

Defined in

getLineItemAdjustmentsTotal

Parameters

Returns

Defined in

getLineItemDiscountAdjustment

Parameters

Returns

Defined in

getLineItemRefund

Parameters

Returns

Defined in

getLineItemTotal

Parameters

Returns

Defined in

19 KiB

Raw Blame History