TaxProviderService

Finds tax providers and assists in tax related operations.

Properties

__configModule__Record<string, unknown>

__container__anyRequired

__moduleDeclaration__Record<string, unknown>

cacheService_ICacheServiceRequired

container_AwilixContainer<any>Required

eventBus_IEventBusServiceRequired

getCacheKeyanyRequired

The cache key to get cache hits by.

manager_EntityManagerRequired

smTaxLineRepo_Repository<ShippingMethodTaxLine> & { deleteForCart: Method deleteForCart ; upsertLines: Method upsertLines }Required

taxLineRepo_Repository<LineItemTaxLine> & { deleteForCart: Method deleteForCart ; upsertLines: Method upsertLines }Required

taxProviderRepo_Repository<TaxProvider>Required

taxRateService_TaxRateServiceRequired

transactionManager_undefined | EntityManagerRequired

Accessors

activeManager_

Returns

EntityManagerEntityManagerRequired

Methods

atomicPhase_

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.

Parameters

work(transactionManager: EntityManager) => Promise<TResult>Required

the transactional work to be done

isolationOrErrorHandlerIsolationLevel | (error: TError) => Promise<void | TResult>

the isolation level to be used for the work.

maybeErrorHandlerOrDontFail(error: TError) => Promise<void | TResult>

Potential error handler

Returns

PromisePromise<TResult>Required

the result of the transactional work

---

clearLineItemsTaxLines

Parameters

itemIdsstring[]Required

Returns

PromisePromise<void>Required

---

clearTaxLines

Parameters

cartIdstringRequired

Returns

PromisePromise<void>Required

---

createShippingTaxLines

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

Parameters

shippingMethodShippingMethodRequired

the shipping method to create tax lines for

calculationContextTaxCalculationContextRequired

the calculation context to get tax lines by

Returns

PromisePromise<(LineItemTaxLine | ShippingMethodTaxLine)[]>Required

the newly created tax lines

---

createTaxLines

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

Parameters

cartOrLineItemsCart | LineItem[]Required

the cart or line items to create tax lines for

calculationContextTaxCalculationContextRequired

the calculation context to get tax lines by

Returns

PromisePromise<(LineItemTaxLine | ShippingMethodTaxLine)[]>Required

the newly created tax lines

---

getRegionRatesForProduct

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

Parameters

productIdsstring | string[]Required

regionRegionDetailsRequired

the region to get configured rates for.

Returns

PromisePromise<Map<string, TaxServiceRate[]>>Required

the tax rates configured for the shipping option. A map by product id

---

getRegionRatesForShipping

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

Parameters

optionIdstringRequired

the option id of the shipping method.

regionDetailsRegionDetailsRequired

the region to get configured rates for.

Returns

PromisePromise<TaxServiceRate[]>Required

the tax rates configured for the shipping option.

---

getShippingTaxLines

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

shippingMethodShippingMethodRequired

the shipping method to get tax lines for

calculationContextTaxCalculationContextRequired

the calculation context to get tax lines by

Returns

PromisePromise<ShippingMethodTaxLine[]>Required

the computed tax lines

---

getTaxLines

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

lineItemsLineItem[]Required

the cart or order to get tax lines for

calculationContextTaxCalculationContextRequired

the calculation context to get tax lines by

Returns

PromisePromise<(LineItemTaxLine | ShippingMethodTaxLine)[]>Required

the computed tax lines

---

getTaxLinesMap

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

Parameters

itemsLineItem[]Required

calculationContextTaxCalculationContextRequired

Returns

PromisePromise<TaxLinesMaps>Required

---

list

Returns

PromisePromise<TaxProvider[]>Required

---

registerInstalledProviders

Parameters

providersstring[]Required

Returns

PromisePromise<void>Required

---

retrieveProvider

Retrieves the relevant tax provider for the given region.

Parameters

regionRegionRequired

the region to get tax provider for.

Returns

getTaxLines(itemLines: ItemTaxCalculationLine[], shippingLines: ShippingTaxCalculationLine[], context: TaxCalculationContext) => Promise<ProviderTaxLine[]>Required

---

shouldRetryTransaction_

Parameters

errRecord<string, unknown> | { code: string }Required

Returns

booleanboolean

---

withTransaction

Parameters

transactionManagerEntityManager

Returns

TaxProviderServiceTaxProviderServiceRequired