914d773d3a
* initialized next.js project * finished markdown sections * added operation schema component * change page metadata * eslint fixes * fixes related to deployment * added response schema * resolve max stack issue * support for different property types * added support for property types * added loading for components * added more loading * type fixes * added oneOf type * removed console * fix replace with push * refactored everything * use static content for description * fixes and improvements * added code examples section * fix path name * optimizations * fixed tag navigation * add support for admin and store references * general enhancements * optimizations and fixes * fixes and enhancements * added search bar * loading enhancements * added loading * added code blocks * added margin top * add empty response text * fixed oneOf parameters * added path and query parameters * general fixes * added base path env variable * small fix for arrays * enhancements * design enhancements * general enhancements * fix isRequired * added enum values * enhancements * general fixes * general fixes * changed oas generation script * additions to the introduction section * added copy button for code + other enhancements * fix response code block * fix metadata * formatted store introduction * move sidebar logic to Tags component * added test env variables * fix code block bug * added loading animation * added expand param + loading * enhance operation loading * made responsive + improvements * added loading provider * fixed loading * adjustments for small devices * added sidebar label for endpoints * added feedback component * fixed analytics * general fixes * listen to scroll for other headings * added sample env file * update api ref files + support new fields * fix for external docs link * added new sections * fix last item in sidebar not showing * move docs content to www/docs * change redirect url * revert change * resolve build errors * configure rewrites * changed to environment variable url * revert changing environment variable name * add environment variable for API path * fix links * fix tailwind settings * remove vercel file * reconfigured api route * move api page under api * fix page metadata * fix external link in navigation bar * update api spec * updated api specs * fixed google lint error * add max-height on request samples * add padding before loading * fix for one of name * fix undefined types * general fixes * remove response schema example * redesigned navigation bar * redesigned sidebar * fixed up paddings * added feedback component + report issue * fixed up typography, padding, and general styling * redesigned code blocks * optimization * added error timeout * fixes * added indexing with algolia + fixes * fix errors with algolia script * redesign operation sections * fix heading scroll * design fixes * fix padding * fix padding + scroll issues * fix scroll issues * improve scroll performance * fixes for safari * optimization and fixes * fixes to docs + details animation * padding fixes for code block * added tab animation * fixed incorrect link * added selection styling * fix lint errors * redesigned details component * added detailed feedback form * api reference fixes * fix tabs * upgrade + fixes * updated documentation links * optimizations to sidebar items * fix spacing in sidebar item * optimizations and fixes * fix endpoint path styling * remove margin * final fixes * change margin on small devices * generated OAS * fixes for mobile * added feedback modal * optimize dark mode button * fixed color mode useeffect * minimize dom size * use new style system * radius and spacing design system * design fixes * fix eslint errors * added meta files * change cron schedule * fix docusaurus configurations * added operating system to feedback data * change content directory name * fixes to contribution guidelines * revert renaming content * added api-reference to documentation workflow * fixes for search * added dark mode + fixes * oas fixes * handle bugs * added code examples for clients * changed tooltip text * change authentication to card * change page title based on selected section * redesigned mobile navbar * fix icon colors * fix key colors * fix medusa-js installation command * change external regex in algolia * change changeset * fix padding on mobile * fix hydration error * update depedencies
14 KiB
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
medusa/src/services/tax-provider.ts:45
Properties
__configModule__
• Protected Optional Readonly __configModule__: Record<string, unknown>
Inherited from
TransactionBaseService.__configModule__
Defined in
medusa/src/interfaces/transaction-base-service.ts:14
__container__
• Protected Readonly __container__: any
Inherited from
TransactionBaseService.__container__
Defined in
medusa/src/interfaces/transaction-base-service.ts:13
__moduleDeclaration__
• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>
Inherited from
TransactionBaseService.__moduleDeclaration__
Defined in
medusa/src/interfaces/transaction-base-service.ts:15
cacheService_
• Protected Readonly cacheService_: ICacheService
Defined in
medusa/src/services/tax-provider.ts:38
container_
• Protected Readonly container_: AwilixContainer<any>
Defined in
medusa/src/services/tax-provider.ts:37
eventBus_
• Protected Readonly eventBus_: IEventBusService
Defined in
medusa/src/services/tax-provider.ts:43
manager_
• Protected manager_: EntityManager
Inherited from
TransactionBaseService.manager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:5
smTaxLineRepo_
• Protected Readonly smTaxLineRepo_: Repository<ShippingMethodTaxLine> & { deleteForCart: (cartId: string) => Promise<void> ; upsertLines: (lines: ShippingMethodTaxLine[]) => Promise<ShippingMethodTaxLine[]> }
Defined in
medusa/src/services/tax-provider.ts:41
taxLineRepo_
• Protected Readonly taxLineRepo_: Repository<LineItemTaxLine> & { deleteForCart: (cartId: string) => Promise<void> ; upsertLines: (lines: LineItemTaxLine[]) => Promise<LineItemTaxLine[]> }
Defined in
medusa/src/services/tax-provider.ts:40
taxProviderRepo_
• Protected Readonly taxProviderRepo_: Repository<TaxProvider>
Defined in
medusa/src/services/tax-provider.ts:42
taxRateService_
• Protected Readonly taxRateService_: TaxRateService
Defined in
medusa/src/services/tax-provider.ts:39
transactionManager_
• Protected transactionManager_: undefined | EntityManager
Inherited from
TransactionBaseService.transactionManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:6
Accessors
activeManager_
• Protected get activeManager_(): EntityManager
Returns
EntityManager
Inherited from
TransactionBaseService.activeManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:8
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
medusa/src/interfaces/transaction-base-service.ts:56
clearLineItemsTaxLines
▸ clearLineItemsTaxLines(itemIds): Promise<void>
Parameters
| Name | Type |
|---|---|
itemIds |
string[] |
Returns
Promise<void>
Defined in
medusa/src/services/tax-provider.ts:89
clearTaxLines
▸ clearTaxLines(cartId): Promise<void>
Parameters
| Name | Type |
|---|---|
cartId |
string |
Returns
Promise<void>
Defined in
medusa/src/services/tax-provider.ts:97
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
medusa/src/services/tax-provider.ts:171
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
medusa/src/services/tax-provider.ts:117
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
medusa/src/services/tax-provider.ts:499
getRegionRatesForProduct
▸ getRegionRatesForProduct(productIds, region): Promise<Map<string, TaxServiceRate[]>>
Gets the tax rates configured for a product. The rates are cached between calls.
Parameters
| Name | Type | Description |
|---|---|---|
productIds |
string | string[] |
|
region |
RegionDetails |
the region to get configured rates for. |
Returns
Promise<Map<string, TaxServiceRate[]>>
the tax rates configured for the shipping option. A map by product id
Defined in
medusa/src/services/tax-provider.ts:434
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
medusa/src/services/tax-provider.ts:387
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
medusa/src/services/tax-provider.ts:192
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
medusa/src/services/tax-provider.ts:246
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
medusa/src/services/tax-provider.ts:350
list
▸ list(): Promise<TaxProvider[]>
Returns
Promise<TaxProvider[]>
Defined in
medusa/src/services/tax-provider.ts:57
registerInstalledProviders
▸ registerInstalledProviders(providers): Promise<void>
Parameters
| Name | Type |
|---|---|
providers |
string[] |
Returns
Promise<void>
Defined in
medusa/src/services/tax-provider.ts:503
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
medusa/src/services/tax-provider.ts:67
shouldRetryTransaction_
▸ Protected shouldRetryTransaction_(err): boolean
Parameters
| Name | Type |
|---|---|
err |
Record<string, unknown> | { code: string } |
Returns
boolean
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
medusa/src/interfaces/transaction-base-service.ts:37
withTransaction
▸ withTransaction(transactionManager?): TaxProviderService
Parameters
| Name | Type |
|---|---|
transactionManager? |
EntityManager |
Returns
Inherited from
TransactionBaseService.withTransaction