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

docs: update docusaurus to v3 (#5625)

Browse Source 
* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
This commit is contained in:
Shahed Nasser
2023-11-13 20:11:50 +02:00
committed by GitHub
parent cedab58339
commit c6dff873de
2265 changed files with 46163 additions and 47195 deletions
Download Patch File Download Diff File Expand all files Collapse all files

158
www/apps/docs/content/references/services/classes/ClaimService.mdx
View File

@@ -10,14 +10,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### constructor
**new ClaimService**(`«destructured»`)
`**new ClaimService**(«destructured»)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "[`InjectedDependencies`](../types/InjectedDependencies-4.mdx)",
"type": "[InjectedDependencies](../types/InjectedDependencies-4.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -31,7 +31,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -49,7 +49,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "__moduleDeclaration__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -58,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "addressRepository_",
"type": "`Repository`<[`Address`](Address.mdx)\\>",
"type": "Repository&#60;[Address](Address.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "claimItemService_",
"type": "[`ClaimItemService`](ClaimItemService.mdx)",
"type": "[ClaimItemService](ClaimItemService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "claimRepository_",
"type": "`Repository`<[`ClaimOrder`](ClaimOrder.mdx)\\>",
"type": "Repository&#60;[ClaimOrder](ClaimOrder.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "eventBus_",
"type": "[`EventBusService`](EventBusService.mdx)",
"type": "[EventBusService](EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -94,7 +94,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "fulfillmentProviderService_",
"type": "[`FulfillmentProviderService`](FulfillmentProviderService.mdx)",
"type": "[FulfillmentProviderService](FulfillmentProviderService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -103,7 +103,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "fulfillmentService_",
"type": "[`FulfillmentService`](FulfillmentService.mdx)",
"type": "[FulfillmentService](FulfillmentService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -112,7 +112,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "lineItemRepository_",
"type": "`Repository`<[`LineItem`](LineItem.mdx)\\> & { `findByReturn`: Method findByReturn }",
"type": "Repository&#60;[LineItem](LineItem.mdx)&#62; & `&#123; findByReturn: Method findByReturn &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -121,7 +121,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "lineItemService_",
"type": "[`LineItemService`](LineItemService.mdx)",
"type": "[LineItemService](LineItemService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -130,7 +130,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "manager_",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -139,7 +139,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "paymentProviderService_",
"type": "[`PaymentProviderService`](PaymentProviderService.mdx)",
"type": "[PaymentProviderService](PaymentProviderService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -148,7 +148,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "productVariantInventoryService_",
"type": "[`ProductVariantInventoryService`](ProductVariantInventoryService.mdx)",
"type": "[ProductVariantInventoryService](ProductVariantInventoryService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -157,7 +157,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "regionService_",
"type": "[`RegionService`](RegionService.mdx)",
"type": "[RegionService](RegionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -166,7 +166,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "returnService_",
"type": "[`ReturnService`](ReturnService.mdx)",
"type": "[ReturnService](ReturnService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -175,7 +175,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "shippingMethodRepository_",
"type": "`Repository`<[`ShippingMethod`](ShippingMethod.mdx)\\>",
"type": "Repository&#60;[ShippingMethod](ShippingMethod.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -184,7 +184,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "shippingOptionService_",
"type": "[`ShippingOptionService`](ShippingOptionService.mdx)",
"type": "[ShippingOptionService](ShippingOptionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -193,7 +193,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "taxProviderService_",
"type": "[`TaxProviderService`](TaxProviderService.mdx)",
"type": "[TaxProviderService](TaxProviderService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -202,7 +202,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "totalsService_",
"type": "[`TotalsService`](TotalsService.mdx)",
"type": "[TotalsService](TotalsService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -211,7 +211,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"type": "`undefined` \\| EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -287,16 +287,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### activeManager\_
`Protected` `get` **activeManager_**(): `EntityManager`
`Protected get**activeManager_**(): EntityManager`
#### Returns
`EntityManager`
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
@@ -309,7 +309,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### atomicPhase\_
`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
@@ -341,7 +341,7 @@ transaction manager is created.
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => `Promise`<`TResult`\\>",
"type": "(`transactionManager`: EntityManager) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
@@ -350,7 +350,7 @@ transaction manager is created.
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
@@ -359,7 +359,7 @@ transaction manager is created.
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
@@ -370,12 +370,12 @@ transaction manager is created.
#### Returns
`Promise`<`TResult`\>
Promise&#60;TResult&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`TResult`\\>",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
@@ -388,7 +388,7 @@ ___
### cancel
**cancel**(`id`): `Promise`<[`ClaimOrder`](ClaimOrder.mdx)\>
`**cancel**(id): Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;`
#### Parameters
@@ -406,12 +406,12 @@ ___
#### Returns
`Promise`<[`ClaimOrder`](ClaimOrder.mdx)\>
Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ClaimOrder`](ClaimOrder.mdx)\\>",
"type": "Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -424,7 +424,7 @@ ___
### cancelFulfillment
**cancelFulfillment**(`fulfillmentId`): `Promise`<[`ClaimOrder`](ClaimOrder.mdx)\>
`**cancelFulfillment**(fulfillmentId): Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;`
#### Parameters
@@ -442,12 +442,12 @@ ___
#### Returns
`Promise`<[`ClaimOrder`](ClaimOrder.mdx)\>
Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ClaimOrder`](ClaimOrder.mdx)\\>",
"type": "Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -460,7 +460,7 @@ ___
### create
**create**(`data`): `Promise`<[`ClaimOrder`](ClaimOrder.mdx)\>
`**create**(data): Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;`
Creates a Claim on an Order. Claims consists of items that are claimed and
optionally items to be sent as replacement for the claimed items. The
@@ -471,7 +471,7 @@ shipping address that the new items will be shipped to
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`CreateClaimInput`](../types/CreateClaimInput.mdx)",
"type": "[CreateClaimInput](../types/CreateClaimInput.mdx)",
"description": "the object containing all data required to create a claim",
"optional": false,
"defaultValue": "",
@@ -482,12 +482,12 @@ shipping address that the new items will be shipped to
#### Returns
`Promise`<[`ClaimOrder`](ClaimOrder.mdx)\>
Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ClaimOrder`](ClaimOrder.mdx)\\>",
"type": "Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "created claim",
@@ -500,7 +500,7 @@ ___
### createFulfillment
**createFulfillment**(`id`, `config?`): `Promise`<[`ClaimOrder`](ClaimOrder.mdx)\>
`**createFulfillment**(id, config?): Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;`
#### Parameters
@@ -534,7 +534,7 @@ ___
},
{
"name": "config.metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "config metadata",
"optional": true,
"defaultValue": "",
@@ -554,12 +554,12 @@ ___
#### Returns
`Promise`<[`ClaimOrder`](ClaimOrder.mdx)\>
Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ClaimOrder`](ClaimOrder.mdx)\\>",
"type": "Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "created claim",
@@ -572,7 +572,7 @@ ___
### createShipment
**createShipment**(`id`, `fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<[`ClaimOrder`](ClaimOrder.mdx)\>
`**createShipment**(id, fulfillmentId, trackingLinks?, config?): Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;`
#### Parameters
@@ -597,7 +597,7 @@ ___
},
{
"name": "trackingLinks",
"type": "{ `tracking_number`: `string` }[]",
"type": "`&#123; tracking_number: string &#125;`[]",
"description": "",
"optional": false,
"defaultValue": "[]",
@@ -635,12 +635,12 @@ ___
#### Returns
`Promise`<[`ClaimOrder`](ClaimOrder.mdx)\>
Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ClaimOrder`](ClaimOrder.mdx)\\>",
"type": "Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -653,7 +653,7 @@ ___
### getRefundTotalForClaimLinesOnOrder
`Protected` **getRefundTotalForClaimLinesOnOrder**(`order`, `claimItems`): `Promise`<`number`\>
`Protected **getRefundTotalForClaimLinesOnOrder**(order, claimItems): Promise&#60;number&#62;`
Finds claim line items on an order and calculates the refund amount.
There are three places too look:
@@ -667,7 +667,7 @@ Note, it will attempt to return early from each of these places to avoid having
<ParameterTypes parameters={[
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "the order to find claim lines on",
"optional": false,
"defaultValue": "",
@@ -676,7 +676,7 @@ Note, it will attempt to return early from each of these places to avoid having
},
{
"name": "claimItems",
"type": "[`CreateClaimItemInput`](../types/CreateClaimItemInput.mdx)[]",
"type": "[CreateClaimItemInput](../types/CreateClaimItemInput.mdx)[]",
"description": "the claim items to match against",
"optional": false,
"defaultValue": "",
@@ -687,12 +687,12 @@ Note, it will attempt to return early from each of these places to avoid having
#### Returns
`Promise`<`number`\>
Promise&#60;number&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`number`\\>",
"type": "Promise&#60;number&#62;",
"optional": false,
"defaultValue": "",
"description": "the refund amount",
@@ -705,7 +705,7 @@ ___
### list
**list**(`selector`, `config?`): `Promise`<[`ClaimOrder`](ClaimOrder.mdx)[]\>
`**list**(selector, config?): Promise&#60;[ClaimOrder](ClaimOrder.mdx)[]&#62;`
#### Parameters
@@ -721,7 +721,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`ClaimOrder`](ClaimOrder.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[ClaimOrder](ClaimOrder.mdx)&#62;",
"description": "the config object containing query settings",
"optional": false,
"defaultValue": "",
@@ -732,12 +732,12 @@ ___
#### Returns
`Promise`<[`ClaimOrder`](ClaimOrder.mdx)[]\>
Promise&#60;[ClaimOrder](ClaimOrder.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ClaimOrder`](ClaimOrder.mdx)[]\\>",
"type": "Promise&#60;[ClaimOrder](ClaimOrder.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
@@ -750,7 +750,7 @@ ___
### processRefund
**processRefund**(`id`): `Promise`<[`ClaimOrder`](ClaimOrder.mdx)\>
`**processRefund**(id): Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;`
#### Parameters
@@ -768,12 +768,12 @@ ___
#### Returns
`Promise`<[`ClaimOrder`](ClaimOrder.mdx)\>
Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ClaimOrder`](ClaimOrder.mdx)\\>",
"type": "Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -786,7 +786,7 @@ ___
### retrieve
**retrieve**(`claimId`, `config?`): `Promise`<[`ClaimOrder`](ClaimOrder.mdx)\>
`**retrieve**(claimId, config?): Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;`
Gets an order by id.
@@ -804,7 +804,7 @@ Gets an order by id.
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`ClaimOrder`](ClaimOrder.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[ClaimOrder](ClaimOrder.mdx)&#62;",
"description": "the config object containing query settings",
"optional": false,
"defaultValue": "{}",
@@ -815,12 +815,12 @@ Gets an order by id.
#### Returns
`Promise`<[`ClaimOrder`](ClaimOrder.mdx)\>
Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ClaimOrder`](ClaimOrder.mdx)\\>",
"type": "Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the order document",
@@ -833,14 +833,14 @@ ___
### shouldRetryTransaction\_
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "Record<`string`, `unknown`\\> \\| { `code`: `string` }",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -869,7 +869,7 @@ ___
### update
**update**(`id`, `data`): `Promise`<[`ClaimOrder`](ClaimOrder.mdx)\>
`**update**(id, data): Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;`
#### Parameters
@@ -885,7 +885,7 @@ ___
},
{
"name": "data",
"type": "[`UpdateClaimInput`](../types/UpdateClaimInput.mdx)",
"type": "[UpdateClaimInput](../types/UpdateClaimInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -896,12 +896,12 @@ ___
#### Returns
`Promise`<[`ClaimOrder`](ClaimOrder.mdx)\>
Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ClaimOrder`](ClaimOrder.mdx)\\>",
"type": "Promise&#60;[ClaimOrder](ClaimOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -914,14 +914,14 @@ ___
### validateCreateClaimInput
`Protected` **validateCreateClaimInput**(`data`): `Promise`<`void`\>
`Protected **validateCreateClaimInput**(data): Promise&#60;void&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`CreateClaimInput`](../types/CreateClaimInput.mdx)",
"type": "[CreateClaimInput](../types/CreateClaimInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -932,12 +932,12 @@ ___
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -950,14 +950,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`ClaimService`](ClaimService.mdx)
`**withTransaction**(transactionManager?): [ClaimService](ClaimService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -968,12 +968,12 @@ ___
#### Returns
[`ClaimService`](ClaimService.mdx)
[ClaimService](ClaimService.mdx)
<ParameterTypes parameters={[
{
"name": "default",
"type": "[`ClaimService`](ClaimService.mdx)",
"type": "[ClaimService](ClaimService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",