asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: enhance how references are generated (#5805)

Browse Source 
* adjusted configurations

* enhancements to tool and configurations

* change reference in docs

* fixed issue in workflows reference

* added project name

* more optimizations

* fix context error

* added a types reference

* resolved missing types

* fix reference reflection types not having children

* add an expand url parameter

* added new option to the README

* added details about new option
This commit is contained in:
Shahed Nasser
2023-12-05 15:29:41 +02:00
committed by GitHub
parent a418e6cebc
commit 892d737c1f
4358 changed files with 947876 additions and 534760 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/services/classes/services.TaxProviderService.mdx
+804
View File
@@ -0,0 +1,804 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# TaxProviderService
Finds tax providers and assists in tax related operations.
## constructor
### Parameters
<ParameterTypes parameters={[
{
"name": "container",
"type": "AwilixContainer&#60;any&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "cacheService_",
"type": "`ICacheService`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "container_",
"type": "AwilixContainer&#60;any&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBus_",
"type": "`IEventBusService`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "smTaxLineRepo_",
"type": "Repository&#60;[ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "taxLineRepo_",
"type": "Repository&#60;[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "taxProviderRepo_",
"type": "Repository&#60;[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "taxRateService_",
"type": "[TaxRateService](services.TaxRateService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
___
## Accessors
### activeManager\_
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
## 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.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
___
### clearLineItemsTaxLines
#### Parameters
<ParameterTypes parameters={[
{
"name": "itemIds",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### clearTaxLines
#### Parameters
<ParameterTypes parameters={[
{
"name": "cartId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### createShippingTaxLines
Persists the tax lines relevant for a shipping method to the database. Used
for return shipping methods.
#### Parameters
<ParameterTypes parameters={[
{
"name": "shippingMethod",
"type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)",
"description": "the shipping method to create tax lines for",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "calculationContext",
"type": "[TaxCalculationContext](../../medusa/types/medusa.TaxCalculationContext.mdx)",
"description": "the calculation context to get tax lines by",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;([LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx) \\| [ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx))[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the newly created tax lines",
"expandable": false,
"children": []
}
]} />
___
### createTaxLines
Persists the tax lines relevant for an order to the database.
#### Parameters
<ParameterTypes parameters={[
{
"name": "cartOrLineItems",
"type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[] \\| [Cart](../../entities/classes/entities.Cart.mdx)",
"description": "the cart or line items to create tax lines for",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "calculationContext",
"type": "[TaxCalculationContext](../../medusa/types/medusa.TaxCalculationContext.mdx)",
"description": "the calculation context to get tax lines by",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;([LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx) \\| [ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx))[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the newly created tax lines",
"expandable": false,
"children": []
}
]} />
___
### getCacheKey
The cache key to get cache hits by.
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "the entity id to cache",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "regionId",
"type": "`string`",
"description": "the region id to cache",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "string",
"type": "`string`",
"optional": true,
"defaultValue": "",
"description": "the cache key to use for the id set",
"expandable": false,
"children": []
}
]} />
___
### getRegionRatesForProduct
Gets the tax rates configured for a product. The rates are cached between
calls.
#### Parameters
<ParameterTypes parameters={[
{
"name": "productIds",
"type": "`string` \\| `string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "region",
"type": "`RegionDetails`",
"description": "the region to get configured rates for.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;Map&#60;string, [TaxServiceRate](../../medusa/types/medusa.TaxServiceRate.mdx)[]&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "the tax rates configured for the shipping option. A map by product id",
"expandable": false,
"children": []
}
]} />
___
### getRegionRatesForShipping
Gets the tax rates configured for a shipping option. The rates are cached
between calls.
#### Parameters
<ParameterTypes parameters={[
{
"name": "optionId",
"type": "`string`",
"description": "the option id of the shipping method.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "regionDetails",
"type": "`RegionDetails`",
"description": "the region to get configured rates for.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[TaxServiceRate](../../medusa/types/medusa.TaxServiceRate.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the tax rates configured for the shipping option.",
"expandable": false,
"children": []
}
]} />
___
### 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
<ParameterTypes parameters={[
{
"name": "shippingMethod",
"type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)",
"description": "the shipping method to get tax lines for",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "calculationContext",
"type": "[TaxCalculationContext](../../medusa/types/medusa.TaxCalculationContext.mdx)",
"description": "the calculation context to get tax lines by",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the computed tax lines",
"expandable": false,
"children": []
}
]} />
___
### 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
<ParameterTypes parameters={[
{
"name": "lineItems",
"type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
"description": "the cart or order to get tax lines for",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "calculationContext",
"type": "[TaxCalculationContext](../../medusa/types/medusa.TaxCalculationContext.mdx)",
"description": "the calculation context to get tax lines by",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;([LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx) \\| [ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx))[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the computed tax lines",
"expandable": false,
"children": []
}
]} />
___
### getTaxLinesMap
Return a map of tax lines for line items and shipping methods
#### Parameters
<ParameterTypes parameters={[
{
"name": "items",
"type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "calculationContext",
"type": "[TaxCalculationContext](../../medusa/types/medusa.TaxCalculationContext.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TaxLinesMaps&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### list
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### registerInstalledProviders
#### Parameters
<ParameterTypes parameters={[
{
"name": "providers",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### retrieveProvider
Retrieves the relevant tax provider for the given region.
#### Parameters
<ParameterTypes parameters={[
{
"name": "region",
"type": "[Region](../../entities/classes/entities.Region.mdx)",
"description": "the region to get tax provider for.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "ITaxService",
"type": "`object`",
"description": "Interface to be implemented by tax provider plugins. The interface defines a\nsingle method `getTaxLines` that returns numerical rates to apply to line\nitems and shipping methods.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
___
### shouldRetryTransaction\_
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### withTransaction
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "TaxProviderService",
"type": "`object`",
"description": "Finds tax providers and assists in tax related operations.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />