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
www/apps/docs/content/references/services/classes/FulfillmentService.mdx
+65 -65
View File
@@ -12,14 +12,14 @@ Handles Fulfillments
### constructor
**new FulfillmentService**(`«destructured»`)
`**new FulfillmentService**(«destructured»)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "[`InjectedDependencies`](../types/InjectedDependencies-11.mdx)",
"type": "[InjectedDependencies](../types/InjectedDependencies-11.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -33,7 +33,7 @@ Handles Fulfillments
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -51,7 +51,7 @@ Handles Fulfillments
},
{
"name": "__moduleDeclaration__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -60,7 +60,7 @@ Handles Fulfillments
},
{
"name": "fulfillmentProviderService_",
"type": "[`FulfillmentProviderService`](FulfillmentProviderService.mdx)",
"type": "[FulfillmentProviderService](FulfillmentProviderService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -69,7 +69,7 @@ Handles Fulfillments
},
{
"name": "fulfillmentRepository_",
"type": "`Repository`<[`Fulfillment`](Fulfillment.mdx)\\>",
"type": "Repository&#60;[Fulfillment](Fulfillment.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -78,7 +78,7 @@ Handles Fulfillments
},
{
"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": "",
@@ -87,7 +87,7 @@ Handles Fulfillments
},
{
"name": "lineItemService_",
"type": "[`LineItemService`](LineItemService.mdx)",
"type": "[LineItemService](LineItemService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -96,7 +96,7 @@ Handles Fulfillments
},
{
"name": "manager_",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -105,7 +105,7 @@ Handles Fulfillments
},
{
"name": "productVariantInventoryService_",
"type": "[`ProductVariantInventoryService`](ProductVariantInventoryService.mdx)",
"type": "[ProductVariantInventoryService](ProductVariantInventoryService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -114,7 +114,7 @@ Handles Fulfillments
},
{
"name": "shippingProfileService_",
"type": "[`ShippingProfileService`](ShippingProfileService.mdx)",
"type": "[ShippingProfileService](ShippingProfileService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -123,7 +123,7 @@ Handles Fulfillments
},
{
"name": "totalsService_",
"type": "[`TotalsService`](TotalsService.mdx)",
"type": "[TotalsService](TotalsService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -132,7 +132,7 @@ Handles Fulfillments
},
{
"name": "trackingLinkRepository_",
"type": "`Repository`<[`TrackingLink`](TrackingLink.mdx)\\>",
"type": "Repository&#60;[TrackingLink](TrackingLink.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -141,7 +141,7 @@ Handles Fulfillments
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"type": "`undefined` \\| EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -154,16 +154,16 @@ Handles Fulfillments
### activeManager\_
`Protected` `get` **activeManager_**(): `EntityManager`
`Protected get**activeManager_**(): EntityManager`
#### Returns
`EntityManager`
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
@@ -176,7 +176,7 @@ Handles Fulfillments
### 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
@@ -208,7 +208,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": "",
@@ -217,7 +217,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": "",
@@ -226,7 +226,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": "",
@@ -237,12 +237,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",
@@ -255,10 +255,10 @@ ___
### cancelFulfillment
**cancelFulfillment**(`fulfillmentOrId`): `Promise`<[`Fulfillment`](Fulfillment.mdx)\>
`**cancelFulfillment**(fulfillmentOrId): Promise&#60;[Fulfillment](Fulfillment.mdx)&#62;`
Cancels a fulfillment with the fulfillment provider. Will decrement the
fulfillment_quantity on the line items associated with the fulfillment.
fulfillment\_quantity on the line items associated with the fulfillment.
Throws if the fulfillment has already been shipped.
#### Parameters
@@ -266,7 +266,7 @@ Throws if the fulfillment has already been shipped.
<ParameterTypes parameters={[
{
"name": "fulfillmentOrId",
"type": "`string` \\| [`Fulfillment`](Fulfillment.mdx)",
"type": "`string` \\| [Fulfillment](Fulfillment.mdx)",
"description": "the fulfillment object or id.",
"optional": false,
"defaultValue": "",
@@ -277,12 +277,12 @@ Throws if the fulfillment has already been shipped.
#### Returns
`Promise`<[`Fulfillment`](Fulfillment.mdx)\>
Promise&#60;[Fulfillment](Fulfillment.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Fulfillment`](Fulfillment.mdx)\\>",
"type": "Promise&#60;[Fulfillment](Fulfillment.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the save operation",
@@ -295,7 +295,7 @@ ___
### createFulfillment
**createFulfillment**(`order`, `itemsToFulfill`, `custom?`): `Promise`<[`Fulfillment`](Fulfillment.mdx)[]\>
`**createFulfillment**(order, itemsToFulfill, custom?): Promise&#60;[Fulfillment](Fulfillment.mdx)[]&#62;`
Creates an order fulfillment
If items needs to be fulfilled by different provider, we make
@@ -307,7 +307,7 @@ those partitions.
<ParameterTypes parameters={[
{
"name": "order",
"type": "[`CreateFulfillmentOrder`](../types/CreateFulfillmentOrder.mdx)",
"type": "[CreateFulfillmentOrder](../types/CreateFulfillmentOrder.mdx)",
"description": "order to create fulfillment for",
"optional": false,
"defaultValue": "",
@@ -316,7 +316,7 @@ those partitions.
},
{
"name": "itemsToFulfill",
"type": "[`FulFillmentItemType`](../types/FulFillmentItemType.mdx)[]",
"type": "[FulFillmentItemType](../types/FulFillmentItemType.mdx)[]",
"description": "the items in the order to fulfill",
"optional": false,
"defaultValue": "",
@@ -325,7 +325,7 @@ those partitions.
},
{
"name": "custom",
"type": "[`Partial`](../types/Partial.mdx)<[`Fulfillment`](Fulfillment.mdx)\\>",
"type": "[Partial](../types/Partial.mdx)&#60;[Fulfillment](Fulfillment.mdx)&#62;",
"description": "potential custom values to add",
"optional": false,
"defaultValue": "{}",
@@ -336,12 +336,12 @@ those partitions.
#### Returns
`Promise`<[`Fulfillment`](Fulfillment.mdx)[]\>
Promise&#60;[Fulfillment](Fulfillment.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Fulfillment`](Fulfillment.mdx)[]\\>",
"type": "Promise&#60;[Fulfillment](Fulfillment.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the created fulfillments",
@@ -354,7 +354,7 @@ ___
### createShipment
**createShipment**(`fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<[`Fulfillment`](Fulfillment.mdx)\>
`**createShipment**(fulfillmentId, trackingLinks?, config?): Promise&#60;[Fulfillment](Fulfillment.mdx)&#62;`
Creates a shipment by marking a fulfillment as shipped. Adds
tracking links and potentially more metadata.
@@ -373,7 +373,7 @@ tracking links and potentially more metadata.
},
{
"name": "trackingLinks",
"type": "{ `tracking_number`: `string` }[]",
"type": "`&#123; tracking_number: string &#125;`[]",
"description": "tracking links for the shipment",
"optional": true,
"defaultValue": "",
@@ -382,8 +382,8 @@ tracking links and potentially more metadata.
},
{
"name": "config",
"type": "[`CreateShipmentConfig`](../types/CreateShipmentConfig.mdx)",
"description": "potential configuration settings, such as no_notification and metadata",
"type": "[CreateShipmentConfig](../types/CreateShipmentConfig.mdx)",
"description": "potential configuration settings, such as no\\_notification and metadata",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -393,12 +393,12 @@ tracking links and potentially more metadata.
#### Returns
`Promise`<[`Fulfillment`](Fulfillment.mdx)\>
Promise&#60;[Fulfillment](Fulfillment.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Fulfillment`](Fulfillment.mdx)\\>",
"type": "Promise&#60;[Fulfillment](Fulfillment.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the shipped fulfillment",
@@ -411,7 +411,7 @@ ___
### getFulfillmentItems\_
**getFulfillmentItems_**(`order`, `items`): `Promise`<(``null`` \| [`LineItem`](LineItem.mdx))[]\>
`**getFulfillmentItems_**(order, items): Promise&#60;(`null` \| [LineItem](LineItem.mdx))[]&#62;`
Retrieves the order line items, given an array of items.
@@ -420,7 +420,7 @@ Retrieves the order line items, given an array of items.
<ParameterTypes parameters={[
{
"name": "order",
"type": "[`CreateFulfillmentOrder`](../types/CreateFulfillmentOrder.mdx)",
"type": "[CreateFulfillmentOrder](../types/CreateFulfillmentOrder.mdx)",
"description": "the order to get line items from",
"optional": false,
"defaultValue": "",
@@ -429,7 +429,7 @@ Retrieves the order line items, given an array of items.
},
{
"name": "items",
"type": "[`FulFillmentItemType`](../types/FulFillmentItemType.mdx)[]",
"type": "[FulFillmentItemType](../types/FulFillmentItemType.mdx)[]",
"description": "the items to get",
"optional": false,
"defaultValue": "",
@@ -440,12 +440,12 @@ Retrieves the order line items, given an array of items.
#### Returns
`Promise`<(``null`` \| [`LineItem`](LineItem.mdx))[]\>
Promise&#60;(`null` \| [LineItem](LineItem.mdx))[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<(``null`` \\| [`LineItem`](LineItem.mdx))[]\\>",
"type": "Promise&#60;(`null` \\| [LineItem](LineItem.mdx))[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the line items generated by the transformer.",
@@ -458,14 +458,14 @@ ___
### partitionItems\_
**partitionItems_**(`shippingMethods`, `items`): [`FulfillmentItemPartition`](../types/FulfillmentItemPartition.mdx)[]
`**partitionItems_**(shippingMethods, items): [FulfillmentItemPartition](../types/FulfillmentItemPartition.mdx)[]`
#### Parameters
<ParameterTypes parameters={[
{
"name": "shippingMethods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -474,7 +474,7 @@ ___
},
{
"name": "items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -485,12 +485,12 @@ ___
#### Returns
[`FulfillmentItemPartition`](../types/FulfillmentItemPartition.mdx)[]
[FulfillmentItemPartition](../types/FulfillmentItemPartition.mdx)[]
<ParameterTypes parameters={[
{
"name": "FulfillmentItemPartition[]",
"type": "[`FulfillmentItemPartition`](../types/FulfillmentItemPartition.mdx)[]",
"type": "[FulfillmentItemPartition](../types/FulfillmentItemPartition.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",
@@ -503,7 +503,7 @@ ___
### retrieve
**retrieve**(`fulfillmentId`, `config?`): `Promise`<[`Fulfillment`](Fulfillment.mdx)\>
`**retrieve**(fulfillmentId, config?): Promise&#60;[Fulfillment](Fulfillment.mdx)&#62;`
Retrieves a fulfillment by its id.
@@ -521,7 +521,7 @@ Retrieves a fulfillment by its id.
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`Fulfillment`](Fulfillment.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[Fulfillment](Fulfillment.mdx)&#62;",
"description": "optional values to include with fulfillmentRepository query",
"optional": false,
"defaultValue": "{}",
@@ -532,12 +532,12 @@ Retrieves a fulfillment by its id.
#### Returns
`Promise`<[`Fulfillment`](Fulfillment.mdx)\>
Promise&#60;[Fulfillment](Fulfillment.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Fulfillment`](Fulfillment.mdx)\\>",
"type": "Promise&#60;[Fulfillment](Fulfillment.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the fulfillment",
@@ -550,14 +550,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": "",
@@ -586,7 +586,7 @@ ___
### validateFulfillmentLineItem\_
**validateFulfillmentLineItem_**(`item`, `quantity`): ``null`` \| [`LineItem`](LineItem.mdx)
`**validateFulfillmentLineItem_**(item, quantity): `null` \| [LineItem](LineItem.mdx)`
Checks that a given quantity of a line item can be fulfilled. Fails if the
fulfillable quantity is lower than the requested fulfillment quantity.
@@ -598,7 +598,7 @@ quantity from the quantity that was originally purchased.
<ParameterTypes parameters={[
{
"name": "item",
"type": "`undefined` \\| [`LineItem`](LineItem.mdx)",
"type": "`undefined` \\| [LineItem](LineItem.mdx)",
"description": "the line item to check has sufficient fulfillable quantity.",
"optional": false,
"defaultValue": "",
@@ -618,12 +618,12 @@ quantity from the quantity that was originally purchased.
#### Returns
``null`` \| [`LineItem`](LineItem.mdx)
``null`` \| [LineItem](LineItem.mdx)
<ParameterTypes parameters={[
{
"name": "``null`` \\| LineItem",
"type": "``null`` \\| [`LineItem`](LineItem.mdx)",
"name": "`null` \\| LineItem",
"type": "``null`` \\| [LineItem](LineItem.mdx)",
"optional": true,
"defaultValue": "",
"description": "a line item that has the requested fulfillment quantity\n set.",
@@ -636,14 +636,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`FulfillmentService`](FulfillmentService.mdx)
`**withTransaction**(transactionManager?): [FulfillmentService](FulfillmentService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -654,12 +654,12 @@ ___
#### Returns
[`FulfillmentService`](FulfillmentService.mdx)
[FulfillmentService](FulfillmentService.mdx)
<ParameterTypes parameters={[
{
"name": "FulfillmentService",
"type": "[`FulfillmentService`](FulfillmentService.mdx)",
"type": "[FulfillmentService](FulfillmentService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",