Files

Shahed Nasser 6f1b49af03 chore: merge docs from master to develop (#3650 )

* Fix issue on fixed total amount discount when using includes tax (#3472)

The calculation of the fixed discount amount breaks when having includes_tax setting active, due to the line item totals are incorrect and returning everything as 0, thus the totalItemPercentage will be Infinitiy due to the division by a subtotal of 0

* chore: Add missing changeset for @medusajs/medusa

* feat(medusa): Improve performance of Products domain (#3417)

* feat(medusa): Improve product update performances

* fix tests and update

* update mock repo

* improve repo

* cleanup

* fix

* cleanup + bulk emit + unit test fix

* improvements

* improve

* fix unit tests

* fix export

* fix product update handler

* enhance mock repo

* fix import integration

* fix end point tests

* revert mock repo product variant

* fix unit

* cleanup

* cleanup

* address feedback

* fix quotes in tests

* address feedback

* Create new-tips-mate.md

* use types

* chore: Remove integration-tests from changeset

* chore(release): v1.7.14

* chore(docs): Generated Docs Announcement Bar (automated) (#3489)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>

* fix(medusa): EventBusService.emit using Redis mock (#3491)

* Fix eventBusService.emit using redis mock

* revert gitignore

* enqueuer

* unit test add redis_url

* fix test

* chore(docs): Generated Services Reference (automated) (#3490)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>

* docs: publish restructure (#3496)

* docs: added features and guides overview page

* added image

* added version 2

* added version 3

* added version 4

* docs: implemented new color scheme

* docs: redesigned sidebar (#3193)

* docs: redesigned navbar for restructure (#3199)

* docs: redesigned footer (#3209)

* docs: redesigned cards (#3230)

* docs: redesigned admonitions (#3231)

* docs: redesign announcement bar (#3236)

* docs: redesigned large cards (#3239)

* docs: redesigned code blocks (#3253)

* docs: redesigned search modal and page (#3264)

* docs: redesigned doc footer (#3268)

* docs: added new sidebars + refactored css and assets (#3279)

* docs: redesigned api reference sidebar

* docs: refactored css

* docs: added code tabs transition

* docs: added new sidebars

* removed unused assets

* remove unusued assets

* Fix deploy errors

* fix incorrect link

* docs: fixed code responsivity + missing icons (#3283)

* docs: changed icons (#3296)

* docs: design fixes to the sidebar (#3297)

* redesign fixes

* docs: small design fixes

* docs: several design fixes after restructure (#3299)

* docs: bordered icon fixes

* docs: desgin fixes

* fixes to code blocks and sidebar scroll

* design adjustments

* docs: restructured homepage (#3305)

* docs: restructured homepage

* design fixes

* fixed core concepts icon

* docs: added core concepts page (#3318)

* docs: restructured homepage

* design fixes

* docs: added core concepts page

* changed text of different components

* docs: added architecture link

* added missing prop for user guide

* docs: added regions overview page (#3327)

* docs: added regions overview

* moved region pages to new structure

* docs: fixed description of regions architecture page

* small changes

* small fix

* docs: added customers overview page (#3331)

* docs: added regions overview

* moved region pages to new structure

* docs: fixed description of regions architecture page

* small changes

* small fix

* docs: added customers overview page

* fix link

* resolve link issues

* docs: updated regions architecture image

* docs: second-iteration fixes (#3347)

* docs: redesigned document

* design fixes

* docs: added products overview page (#3354)

* docs: added carts overview page (#3363)

* docs: added orders overview (#3364)

* docs: added orders overview

* added links in overview

* docs: added vercel redirects

* docs: added soon badge for cards (#3389)

* docs: resolved feedback changes + organized troubleshooting pages (#3409)

* docs: resolved feedback changes

* added extra line

* docs: changed icons for restructure (#3421)

* docs: added taxes overview page (#3422)

* docs: added taxes overview page

* docs: fix sidebar label

* added link to taxes overview page

* fixed link

* docs: fixed sidebar scroll (#3429)

* docs: added discounts overview (#3432)

* docs: added discounts overview

* fixed links

* docs: added gift cards overview (#3433)

* docs: added price lists overview page (#3440)

* docs: added price lists overview page

* fixed links

* docs: added sales channels overview page (#3441)

* docs: added sales overview page

* fixed links

* docs: added users overview (#3443)

* docs: fixed sidebar border height (#3444)

* docs: fixed sidebar border height

* fixed svg markup

* docs: added possible solutions to feedback component (#3449)

* docs: added several overview pages + restructured files (#3463)

* docs: added several overview pages

* fixed links

* docs: added feature flags + PAK overview pages (#3464)

* docs: added feature flags + PAK overview pages

* fixed links

* fix link

* fix link

* fixed links colors

* docs: added strategies overview page (#3468)

* docs: automated upgrade guide (#3470)

* docs: automated upgrade guide

* fixed vercel redirect

* docs: restructured files in docs codebase (#3475)

* docs: restructured files

* docs: fixed eslint exception

* docs: finished restructure loose-ends (#3493)

* fixed uses of backend

* docs: finished loose ends

* eslint fixes

* fixed links

* merged master

* added update instructions for v1.7.12

* docs: fixed discount details (#3499)

* docs: fix trailing slash causing 404 (#3508)

* docs: fix error during navigation (#3509)

* docs: removed the gatsby storefront guide (#3527)

* docs: removed the gatsby storefront guide

* docs: fixed query value

* chore(docs): Removed Docs Announcement Bar (automated) (#3536)

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>

* fix(medusa): Variant update should include the id for the listeners to be able to identify the entity (#3539)

* fix(medusa): Variant update should include the id for the listeners to be able to identify the entity

* fix unit tests

* Create brave-seahorses-film.md

* docs: fix admin redirects (#3548)

* chore(release): v1.7.15

* chore(docs): Generated Docs Announcement Bar (automated) (#3550)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>

* chore(docs): Generated Services Reference (automated) (#3551)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>

* chore: updated READMEs of plugins (#3546)

* chore: updated READMEs of plugins

* added notice to plugins

* docs: added a deploy guide for next.js storefront (#3558)

* docs: added a deploy next.js guide

* docs: fix image zoom

* docs: fixes to next.js deployment guide to vercel (#3562)

* chore(workflows): Enable manual workflow in pre-release mode (#3566)

* chore(docs): Removed Docs Announcement Bar (automated) (#3598)

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>

* fix(medusa): Rounding issues on line item adjustments (#3446)

* chores(medusa): Attempt to fix discount rounding issues

* add migration

* update entities

* apply multipler factor properly

* fix discount service

* WIP

* fix rounding issues in discounts

* fix some tests

* Exclude raw_discount_total from responses

* fix adjustments

* cleanup response

* fix

* fix draft order integration

* fix order integration

* fix order integration

* address feedback

* fix test

* Create .changeset/polite-llamas-sit.md

* remove comment

---------

Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>

* chore(workflows): Add release notification (#3629)

---------

Co-authored-by: pepijn-vanvlaanderen <pepijn@webbers.com>
Co-authored-by: olivermrbl <oliver@mrbltech.com>
Co-authored-by: Adrien de Peretti <adrien.deperetti@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>

2023-03-31 09:34:38 +02:00

20 KiB

Raw Blame History

Class: TotalsService

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

Implements

Hierarchy

TransactionBaseService

↳ TotalsService

Constructors

constructor

• new TotalsService(__namedParameters)

Parameters

Name	Type
`__namedParameters`	`TotalsServiceProps`

Overrides

TransactionBaseService.constructor

Defined in

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

Properties

configModule

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

Inherited from

TransactionBaseService.__configModule__

Defined in

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

container

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

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

moduleDeclaration

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

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

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

featureFlagRouter_

• Protected Readonly featureFlagRouter_: FlagRouter

Defined in

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

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

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

newTotalsService_

• Protected Readonly newTotalsService_: NewTotalsService

Defined in

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

taxCalculationStrategy_

• Protected Readonly taxCalculationStrategy_: ITaxCalculationStrategy

Defined in

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

taxProviderService_

• Protected Readonly taxProviderService_: TaxProviderService

Defined in

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

transactionManager_

• Protected transactionManager_: EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

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

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:50

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:629

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`	`Cart` \| `Order`	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:671

getAllocationMap

▸ getAllocationMap(orderOrCart, options?): Promise<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`	`Object`	the order or cart to get an allocation map for
`orderOrCart.claims?`	`ClaimOrder`[]	-
`orderOrCart.discounts?`	`Discount`[]	-
`orderOrCart.items`	`LineItem`[]	-
`orderOrCart.swaps?`	`Swap`[]	-
`options`	`AllocationMapOptions`	controls what should be included in allocation map

Returns

Promise<LineAllocationsMap>

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

Defined in

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

getCalculationContext

▸ getCalculationContext(calculationContextData, options?): Promise<TaxCalculationContext>

Prepares the calculation context for a tax total calculation.

Parameters

Name	Type	Description
`calculationContextData`	`CalculationContextData`	the calculationContextData to get the calculation context for
`options`	`CalculationContextOptions`	options to gather context by

Returns

Promise<TaxCalculationContext>

the tax calculation context

Defined in

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

getDiscountTotal

▸ getDiscountTotal(cartOrOrder): Promise<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`	`Cart` \| `Order`	the cart or order to calculate discounts for

Returns

Promise<number>

the total discounts amount

Defined in

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

getGiftCardTotal

▸ getGiftCardTotal(cartOrOrder, opts?): Promise<{ tax_total: number ; total: number }>

Gets the gift card amount on a cart or order.

Parameters

Name	Type	Description
`cartOrOrder`	`Cart` \| `Order`	the cart or order to get gift card amount for
`opts`	`Object`	-
`opts.gift_cardable?`	`number`	-

Returns

Promise<{ tax_total: number ; total: number }>

the gift card amount applied to the cart or order

Defined in

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

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`	`Cart` \| `Order`	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:957

getLineDiscounts

▸ getLineDiscounts(cartOrOrder, discount?): LineDiscountAmount[]

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

Parameters

Name	Type	Description
`cartOrOrder`	`Object`	the cart or order to get line discount allocations for
`cartOrOrder.claims?`	`ClaimOrder`[]	-
`cartOrOrder.items`	`LineItem`[]	-
`cartOrOrder.swaps?`	`Swap`[]	-
`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:722

getLineItemAdjustmentsTotal

▸ getLineItemAdjustmentsTotal(cartOrOrder): number

Parameters

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

Returns

number

Defined in

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

getLineItemDiscountAdjustment

▸ getLineItemDiscountAdjustment(lineItem, discount): number

Parameters

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

Returns

number

Defined in

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

getLineItemRefund

▸ getLineItemRefund(order, lineItem): Promise<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

Promise<number>

the line item refund amount.

Defined in

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

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`	`Cart` \| `Order`	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:930

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`	`Cart` \| `Order`	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:778

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:160

getRefundTotal

▸ getRefundTotal(order, lineItems): Promise<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

Promise<number>

the calculated subtotal

Defined in

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

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:492

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`	`Cart` \| `Order`	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:194

getShippingTotal

▸ getShippingTotal(cartOrOrder): Promise<number>

Calculates shipping total

Parameters

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

Returns

Promise<number>

shipping total

Defined in

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

getSubtotal

▸ getSubtotal(cartOrOrder, opts?): Promise<number>

Calculates subtotal of a given cart or order.

Parameters

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

Returns

Promise<number>

the calculated subtotal

Defined in

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

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:175

getTaxTotal

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

Calculates tax total Currently based on the Danish tax system

Parameters

Name	Type	Default value	Description
`cartOrOrder`	`Cart` \| `Order`	`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:349

getTotal

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

Calculates total of a given cart or order.

Parameters

Name	Type	Description
`cartOrOrder`	`Cart` \| `Order`	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:137

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:1055

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:31

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:14

20 KiB Raw Blame History

Class: TotalsService

Hierarchy

Constructors

constructor

Parameters

Overrides

Defined in

Properties

__configModule__

Inherited from

Defined in

__container__

Inherited from

Defined in

__moduleDeclaration__

Inherited from

Defined in

featureFlagRouter_

Defined in

manager_

Overrides

Defined in

newTotalsService_

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

20 KiB

Raw Blame History

configModule

container

moduleDeclaration