asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
a8293af8e1f60d77c7b4b546da692b6cfe85d323
medusa-store/docs/content/references/services/classes/TaxProviderService.md
Shahed Nasser a8293af8e1 fix: overlapping branch names for generated PRs of references (#2097) 
* fix overlapping branch names of generated references

* regenerate references
2022-08-25 17:47:58 +03: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:53

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

container_

• Protected Readonly container_: AwilixContainer<any>

Defined in

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

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

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

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

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

redis_

• Protected Readonly redis_: Redis

Defined in

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

smTaxLineRepo_

• Protected Readonly smTaxLineRepo_: typeof ShippingMethodTaxLineRepository

Defined in

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

taxLineRepo_

• Protected Readonly taxLineRepo_: typeof LineItemTaxLineRepository

Defined in

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

taxProviderRepo_

• Protected Readonly taxProviderRepo_: typeof TaxProviderRepository

Defined in

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

taxRateService_

• Protected Readonly taxRateService_: TaxRateService

Defined in

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

transactionManager_

• Protected transactionManager_: EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

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

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

clearTaxLines

▸ clearTaxLines(cartId): Promise<void>

Parameters

Name Type
cartId string

Returns

Promise<void>

Defined in

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

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

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

getCacheEntry

▸ Private getCacheEntry(productId, regionId): Promise<null | TaxServiceRate[]>

Gets the cache results for a set of ids

Parameters

Name Type Description
productId string the product id to cache
regionId string the region id to cache

Returns

Promise<null | TaxServiceRate[]>

the cached result or null

Defined in

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

getCacheKey

▸ Private getCacheKey(productId, regionId): string

The cache key to get cache hits by.

Parameters

Name Type Description
productId string the product 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:426

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

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

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

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

list

▸ list(): Promise<TaxProvider[]>

Returns

Promise<TaxProvider[]>

Defined in

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

registerInstalledProviders

▸ registerInstalledProviders(providers): Promise<void>

Parameters

Name Type
providers string[]

Returns

Promise<void>

Defined in

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

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

setCache

▸ Private setCache(productId, regionId, value): Promise<void>

Sets the cache results for a set of ids

Parameters

Name Type Description
productId string the product id to cache
regionId string the region id to cache
value TaxServiceRate[] tax rates to cache

Returns

Promise<void>

promise that resolves after the cache has been set

Defined in

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

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

Reference in New Issue View Git Blame Copy Permalink