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

118
www/apps/docs/content/references/services/classes/DraftOrderService.mdx
View File

@@ -14,14 +14,14 @@ Handles draft orders
### constructor
**new DraftOrderService**(`«destructured»`)
`**new DraftOrderService**(«destructured»)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "[`InjectedDependencies`](../types/InjectedDependencies-9.mdx)",
"type": "[InjectedDependencies](../types/InjectedDependencies-9.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -35,7 +35,7 @@ Handles draft orders
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -53,7 +53,7 @@ Handles draft orders
},
{
"name": "__moduleDeclaration__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -62,7 +62,7 @@ Handles draft orders
},
{
"name": "cartService_",
"type": "[`CartService`](CartService.mdx)",
"type": "[CartService](CartService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -71,7 +71,7 @@ Handles draft orders
},
{
"name": "customShippingOptionService_",
"type": "[`CustomShippingOptionService`](CustomShippingOptionService.mdx)",
"type": "[CustomShippingOptionService](CustomShippingOptionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -80,7 +80,7 @@ Handles draft orders
},
{
"name": "draftOrderRepository_",
"type": "`Repository`<[`DraftOrder`](DraftOrder.mdx)\\>",
"type": "Repository&#60;[DraftOrder](DraftOrder.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -89,7 +89,7 @@ Handles draft orders
},
{
"name": "eventBus_",
"type": "[`EventBusService`](EventBusService.mdx)",
"type": "[EventBusService](EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -98,7 +98,7 @@ Handles draft orders
},
{
"name": "lineItemService_",
"type": "[`LineItemService`](LineItemService.mdx)",
"type": "[LineItemService](LineItemService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -107,7 +107,7 @@ Handles draft orders
},
{
"name": "manager_",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -116,7 +116,7 @@ Handles draft orders
},
{
"name": "orderRepository_",
"type": "`Repository`<[`Order`](Order.mdx)\\> & { `findOneWithRelations`: Method findOneWithRelations ; `findWithRelations`: Method findWithRelations }",
"type": "Repository&#60;[Order](Order.mdx)&#62; & `&#123; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -125,7 +125,7 @@ Handles draft orders
},
{
"name": "paymentRepository_",
"type": "`Repository`<[`Payment`](Payment.mdx)\\>",
"type": "Repository&#60;[Payment](Payment.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -134,7 +134,7 @@ Handles draft orders
},
{
"name": "productVariantService_",
"type": "[`ProductVariantService`](ProductVariantService.mdx)",
"type": "[ProductVariantService](ProductVariantService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -143,7 +143,7 @@ Handles draft orders
},
{
"name": "shippingOptionService_",
"type": "[`ShippingOptionService`](ShippingOptionService.mdx)",
"type": "[ShippingOptionService](ShippingOptionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -152,7 +152,7 @@ Handles draft orders
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"type": "`undefined` \\| EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -192,16 +192,16 @@ Handles draft orders
### activeManager\_
`Protected` `get` **activeManager_**(): `EntityManager`
`Protected get**activeManager_**(): EntityManager`
#### Returns
`EntityManager`
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
@@ -214,7 +214,7 @@ Handles draft orders
### 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
@@ -246,7 +246,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": "",
@@ -255,7 +255,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": "",
@@ -264,7 +264,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": "",
@@ -275,12 +275,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",
@@ -293,7 +293,7 @@ ___
### create
**create**(`data`): `Promise`<[`DraftOrder`](DraftOrder.mdx)\>
`**create**(data): Promise&#60;[DraftOrder](DraftOrder.mdx)&#62;`
Creates a draft order.
@@ -302,7 +302,7 @@ Creates a draft order.
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`DraftOrderCreateProps`](../types/DraftOrderCreateProps.mdx)",
"type": "[DraftOrderCreateProps](../types/DraftOrderCreateProps.mdx)",
"description": "data to create draft order from",
"optional": false,
"defaultValue": "",
@@ -313,12 +313,12 @@ Creates a draft order.
#### Returns
`Promise`<[`DraftOrder`](DraftOrder.mdx)\>
Promise&#60;[DraftOrder](DraftOrder.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`DraftOrder`](DraftOrder.mdx)\\>",
"type": "Promise&#60;[DraftOrder](DraftOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the created draft order",
@@ -331,7 +331,7 @@ ___
### delete
**delete**(`draftOrderId`): `Promise`<`undefined` \| [`DraftOrder`](DraftOrder.mdx)\>
`**delete**(draftOrderId): Promise&#60;undefined \| [DraftOrder](DraftOrder.mdx)&#62;`
Deletes draft order idempotently.
@@ -351,12 +351,12 @@ Deletes draft order idempotently.
#### Returns
`Promise`<`undefined` \| [`DraftOrder`](DraftOrder.mdx)\>
Promise&#60;undefined \| [DraftOrder](DraftOrder.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`undefined` \\| [`DraftOrder`](DraftOrder.mdx)\\>",
"type": "Promise&#60;undefined \\| [DraftOrder](DraftOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "empty promise",
@@ -369,7 +369,7 @@ ___
### list
**list**(`selector`, `config?`): `Promise`<[`DraftOrder`](DraftOrder.mdx)[]\>
`**list**(selector, config?): Promise&#60;[DraftOrder](DraftOrder.mdx)[]&#62;`
Lists draft orders
@@ -387,7 +387,7 @@ Lists draft orders
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`DraftOrder`](DraftOrder.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[DraftOrder](DraftOrder.mdx)&#62;",
"description": "configurable attributes for find",
"optional": false,
"defaultValue": "",
@@ -398,12 +398,12 @@ Lists draft orders
#### Returns
`Promise`<[`DraftOrder`](DraftOrder.mdx)[]\>
Promise&#60;[DraftOrder](DraftOrder.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`DraftOrder`](DraftOrder.mdx)[]\\>",
"type": "Promise&#60;[DraftOrder](DraftOrder.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "list of draft orders",
@@ -416,7 +416,7 @@ ___
### listAndCount
**listAndCount**(`selector`, `config?`): `Promise`<[[`DraftOrder`](DraftOrder.mdx)[], `number`]\>
`**listAndCount**(selector, config?): Promise&#60;[[DraftOrder](DraftOrder.mdx)[], number]&#62;`
Lists draft orders alongside the count
@@ -434,7 +434,7 @@ Lists draft orders alongside the count
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`DraftOrder`](DraftOrder.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[DraftOrder](DraftOrder.mdx)&#62;",
"description": "query config",
"optional": false,
"defaultValue": "",
@@ -445,12 +445,12 @@ Lists draft orders alongside the count
#### Returns
`Promise`<[[`DraftOrder`](DraftOrder.mdx)[], `number`]\>
Promise&#60;[[DraftOrder](DraftOrder.mdx)[], number]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`DraftOrder`](DraftOrder.mdx)[], `number`]\\>",
"type": "Promise&#60;[[DraftOrder](DraftOrder.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "draft orders",
@@ -463,7 +463,7 @@ ___
### registerCartCompletion
**registerCartCompletion**(`draftOrderId`, `orderId`): `Promise`<`UpdateResult`\>
`**registerCartCompletion**(draftOrderId, orderId): Promise&#60;UpdateResult&#62;`
Registers a draft order as completed, when an order has been completed.
@@ -492,12 +492,12 @@ Registers a draft order as completed, when an order has been completed.
#### Returns
`Promise`<`UpdateResult`\>
Promise&#60;UpdateResult&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`UpdateResult`\\>",
"type": "Promise&#60;UpdateResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the created order",
@@ -510,7 +510,7 @@ ___
### retrieve
**retrieve**(`draftOrderId`, `config?`): `Promise`<[`DraftOrder`](DraftOrder.mdx)\>
`**retrieve**(draftOrderId, config?): Promise&#60;[DraftOrder](DraftOrder.mdx)&#62;`
Retrieves a draft order with the given id.
@@ -528,7 +528,7 @@ Retrieves a draft order with the given id.
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`DraftOrder`](DraftOrder.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[DraftOrder](DraftOrder.mdx)&#62;",
"description": "query object for findOne",
"optional": false,
"defaultValue": "{}",
@@ -539,12 +539,12 @@ Retrieves a draft order with the given id.
#### Returns
`Promise`<[`DraftOrder`](DraftOrder.mdx)\>
Promise&#60;[DraftOrder](DraftOrder.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`DraftOrder`](DraftOrder.mdx)\\>",
"type": "Promise&#60;[DraftOrder](DraftOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the draft order",
@@ -557,7 +557,7 @@ ___
### retrieveByCartId
**retrieveByCartId**(`cartId`, `config?`): `Promise`<[`DraftOrder`](DraftOrder.mdx)\>
`**retrieveByCartId**(cartId, config?): Promise&#60;[DraftOrder](DraftOrder.mdx)&#62;`
Retrieves a draft order based on its associated cart id
@@ -575,7 +575,7 @@ Retrieves a draft order based on its associated cart id
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`DraftOrder`](DraftOrder.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[DraftOrder](DraftOrder.mdx)&#62;",
"description": "query object for findOne",
"optional": false,
"defaultValue": "{}",
@@ -586,12 +586,12 @@ Retrieves a draft order based on its associated cart id
#### Returns
`Promise`<[`DraftOrder`](DraftOrder.mdx)\>
Promise&#60;[DraftOrder](DraftOrder.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`DraftOrder`](DraftOrder.mdx)\\>",
"type": "Promise&#60;[DraftOrder](DraftOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the draft order",
@@ -604,14 +604,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": "",
@@ -640,7 +640,7 @@ ___
### update
**update**(`id`, `data`): `Promise`<[`DraftOrder`](DraftOrder.mdx)\>
`**update**(id, data): Promise&#60;[DraftOrder](DraftOrder.mdx)&#62;`
Updates a draft order with the given data
@@ -678,12 +678,12 @@ Updates a draft order with the given data
#### Returns
`Promise`<[`DraftOrder`](DraftOrder.mdx)\>
Promise&#60;[DraftOrder](DraftOrder.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`DraftOrder`](DraftOrder.mdx)\\>",
"type": "Promise&#60;[DraftOrder](DraftOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the updated draft order",
@@ -696,14 +696,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`DraftOrderService`](DraftOrderService.mdx)
`**withTransaction**(transactionManager?): [DraftOrderService](DraftOrderService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -714,12 +714,12 @@ ___
#### Returns
[`DraftOrderService`](DraftOrderService.mdx)
[DraftOrderService](DraftOrderService.mdx)
<ParameterTypes parameters={[
{
"name": "DraftOrderService",
"type": "[`DraftOrderService`](DraftOrderService.mdx)",
"type": "[DraftOrderService](DraftOrderService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",