asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
7a9740bad70893f5fb33e426c334e50d43b60a4e
medusa-store/docs/content/references/services/classes/TaxProviderService.md
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

14 KiB
Raw Blame History

Class: TaxProviderService

Finds tax providers and assists in tax related operations.

Hierarchy

  • TransactionBaseService

    ↳ TaxProviderService

Constructors

constructor

• new TaxProviderService(container)

Parameters

Name Type
container AwilixContainer<any>

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/tax-provider.ts:51

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

cacheService_

• Protected Readonly cacheService_: ICacheService

Defined in

packages/medusa/src/services/tax-provider.ts:44

container_

• Protected Readonly container_: AwilixContainer<any>

Defined in

packages/medusa/src/services/tax-provider.ts:43

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

packages/medusa/src/services/tax-provider.ts:49

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/tax-provider.ts:40

smTaxLineRepo_

• Protected Readonly smTaxLineRepo_: typeof ShippingMethodTaxLineRepository

Defined in

packages/medusa/src/services/tax-provider.ts:47

taxLineRepo_

• Protected Readonly taxLineRepo_: typeof LineItemTaxLineRepository

Defined in

packages/medusa/src/services/tax-provider.ts:46

taxProviderRepo_

• Protected Readonly taxProviderRepo_: typeof TaxProviderRepository

Defined in

packages/medusa/src/services/tax-provider.ts:48

taxRateService_

• Protected Readonly taxRateService_: TaxRateService

Defined in

packages/medusa/src/services/tax-provider.ts:45

transactionManager_

• Protected transactionManager_: EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/tax-provider.ts:41

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

clearLineItemsTaxLines

▸ clearLineItemsTaxLines(itemIds): Promise<void>

Parameters

Name Type
itemIds string[]

Returns

Promise<void>

Defined in

packages/medusa/src/services/tax-provider.ts:97

clearTaxLines

▸ clearTaxLines(cartId): Promise<void>

Parameters

Name Type
cartId string

Returns

Promise<void>

Defined in

packages/medusa/src/services/tax-provider.ts:107

createShippingTaxLines

▸ createShippingTaxLines(shippingMethod, calculationContext): Promise<(ShippingMethodTaxLine | LineItemTaxLine)[]>

Persists the tax lines relevant for a shipping method to the database. Used for return shipping methods.

Parameters

Name Type Description
shippingMethod ShippingMethod the shipping method to create tax lines for
calculationContext TaxCalculationContext the calculation context to get tax lines by

Returns

Promise<(ShippingMethodTaxLine | LineItemTaxLine)[]>

the newly created tax lines

Defined in

packages/medusa/src/services/tax-provider.ts:183

createTaxLines

▸ createTaxLines(cartOrLineItems, calculationContext): Promise<(ShippingMethodTaxLine | LineItemTaxLine)[]>

Persists the tax lines relevant for an order to the database.

Parameters

Name Type Description
cartOrLineItems Cart | LineItem[] the cart or line items to create tax lines for
calculationContext TaxCalculationContext the calculation context to get tax lines by

Returns

Promise<(ShippingMethodTaxLine | LineItemTaxLine)[]>

the newly created tax lines

Defined in

packages/medusa/src/services/tax-provider.ts:129

getCacheKey

▸ Private getCacheKey(id, regionId): string

The cache key to get cache hits by.

Parameters

Name Type Description
id string the entity id to cache
regionId string the region id to cache

Returns

string

the cache key to use for the id set

Defined in

packages/medusa/src/services/tax-provider.ts:484

getRegionRatesForProduct

▸ getRegionRatesForProduct(productId, region): Promise<TaxServiceRate[]>

Gets the tax rates configured for a product. The rates are cached between calls.

Parameters

Name Type Description
productId string the product id to get rates for
region RegionDetails the region to get configured rates for.

Returns

Promise<TaxServiceRate[]>

the tax rates configured for the shipping option.

Defined in

packages/medusa/src/services/tax-provider.ts:436

getRegionRatesForShipping

▸ getRegionRatesForShipping(optionId, regionDetails): Promise<TaxServiceRate[]>

Gets the tax rates configured for a shipping option. The rates are cached between calls.

Parameters

Name Type Description
optionId string the option id of the shipping method.
regionDetails RegionDetails the region to get configured rates for.

Returns

Promise<TaxServiceRate[]>

the tax rates configured for the shipping option.

Defined in

packages/medusa/src/services/tax-provider.ts:389

getShippingTaxLines

▸ getShippingTaxLines(shippingMethod, calculationContext): Promise<ShippingMethodTaxLine[]>

Gets the relevant tax lines for a shipping method. Note: this method doesn't persist the tax lines. Use createShippingTaxLines if you wish to persist the tax lines to the DB layer.

Parameters

Name Type Description
shippingMethod ShippingMethod the shipping method to get tax lines for
calculationContext TaxCalculationContext the calculation context to get tax lines by

Returns

Promise<ShippingMethodTaxLine[]>

the computed tax lines

Defined in

packages/medusa/src/services/tax-provider.ts:204

getTaxLines

▸ getTaxLines(lineItems, calculationContext): Promise<(ShippingMethodTaxLine | LineItemTaxLine)[]>

Gets the relevant tax lines for an order or cart. If an order is provided the order's tax lines will be returned. If a cart is provided the tax lines will be computed from the tax rules and potentially a 3rd party tax plugin. Note: this method doesn't persist the tax lines. Use createTaxLines if you wish to persist the tax lines to the DB layer.

Parameters

Name Type Description
lineItems LineItem[] the cart or order to get tax lines for
calculationContext TaxCalculationContext the calculation context to get tax lines by

Returns

Promise<(ShippingMethodTaxLine | LineItemTaxLine)[]>

the computed tax lines

Defined in

packages/medusa/src/services/tax-provider.ts:256

getTaxLinesMap

▸ Protected getTaxLinesMap(items, calculationContext): Promise<TaxLinesMaps>

Return a map of tax lines for line items and shipping methods

Parameters

Name Type
items LineItem[]
calculationContext TaxCalculationContext

Returns

Promise<TaxLinesMaps>

Defined in

packages/medusa/src/services/tax-provider.ts:352

list

▸ list(): Promise<TaxProvider[]>

Returns

Promise<TaxProvider[]>

Defined in

packages/medusa/src/services/tax-provider.ts:65

registerInstalledProviders

▸ registerInstalledProviders(providers): Promise<void>

Parameters

Name Type
providers string[]

Returns

Promise<void>

Defined in

packages/medusa/src/services/tax-provider.ts:488

retrieveProvider

▸ retrieveProvider(region): ITaxService

Retrieves the relevant tax provider for the given region.

Parameters

Name Type Description
region Region the region to get tax provider for.

Returns

ITaxService

the region specific tax provider

Defined in

packages/medusa/src/services/tax-provider.ts:75

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?): TaxProviderService

Parameters

Name Type
transactionManager? EntityManager

Returns

TaxProviderService

Inherited from

TransactionBaseService.withTransaction

Defined in

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

Reference in New Issue View Git Blame Copy Permalink