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

138
www/apps/docs/content/references/services/classes/GiftCardService.mdx
View File

@@ -12,14 +12,14 @@ Provides layer to manipulate gift cards.
### constructor
**new GiftCardService**(`«destructured»`)
`**new GiftCardService**(«destructured»)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "[`InjectedDependencies`](../types/InjectedDependencies-12.mdx)",
"type": "[InjectedDependencies](../types/InjectedDependencies-12.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -33,7 +33,7 @@ Provides layer to manipulate gift cards.
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -51,7 +51,7 @@ Provides layer to manipulate gift cards.
},
{
"name": "__moduleDeclaration__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -60,7 +60,7 @@ Provides layer to manipulate gift cards.
},
{
"name": "eventBus_",
"type": "[`EventBusService`](EventBusService.mdx)",
"type": "[EventBusService](EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -69,7 +69,7 @@ Provides layer to manipulate gift cards.
},
{
"name": "giftCardRepository_",
"type": "`Repository`<[`GiftCard`](GiftCard.mdx)\\> & { `listGiftCardsAndCount`: Method listGiftCardsAndCount }",
"type": "Repository&#60;[GiftCard](GiftCard.mdx)&#62; & `&#123; listGiftCardsAndCount: Method listGiftCardsAndCount &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -78,7 +78,7 @@ Provides layer to manipulate gift cards.
},
{
"name": "giftCardTransactionRepo_",
"type": "`Repository`<[`GiftCardTransaction`](GiftCardTransaction.mdx)\\>",
"type": "Repository&#60;[GiftCardTransaction](GiftCardTransaction.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -87,7 +87,7 @@ Provides layer to manipulate gift cards.
},
{
"name": "manager_",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -96,7 +96,7 @@ Provides layer to manipulate gift cards.
},
{
"name": "regionService_",
"type": "[`RegionService`](RegionService.mdx)",
"type": "[RegionService](RegionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -105,7 +105,7 @@ Provides layer to manipulate gift cards.
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"type": "`undefined` \\| EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -136,16 +136,16 @@ Provides layer to manipulate gift cards.
### activeManager\_
`Protected` `get` **activeManager_**(): `EntityManager`
`Protected get**activeManager_**(): EntityManager`
#### Returns
`EntityManager`
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
@@ -158,7 +158,7 @@ Provides layer to manipulate gift cards.
### 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
@@ -190,7 +190,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": "",
@@ -199,7 +199,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": "",
@@ -208,7 +208,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": "",
@@ -219,12 +219,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",
@@ -237,7 +237,7 @@ ___
### create
**create**(`giftCard`): `Promise`<[`GiftCard`](GiftCard.mdx)\>
`**create**(giftCard): Promise&#60;[GiftCard](GiftCard.mdx)&#62;`
Creates a gift card with provided data given that the data is validated.
@@ -246,7 +246,7 @@ Creates a gift card with provided data given that the data is validated.
<ParameterTypes parameters={[
{
"name": "giftCard",
"type": "[`CreateGiftCardInput`](../types/CreateGiftCardInput.mdx)",
"type": "[CreateGiftCardInput](../types/CreateGiftCardInput.mdx)",
"description": "the gift card data to create",
"optional": false,
"defaultValue": "",
@@ -257,12 +257,12 @@ Creates a gift card with provided data given that the data is validated.
#### Returns
`Promise`<[`GiftCard`](GiftCard.mdx)\>
Promise&#60;[GiftCard](GiftCard.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`GiftCard`](GiftCard.mdx)\\>",
"type": "Promise&#60;[GiftCard](GiftCard.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the create operation",
@@ -275,14 +275,14 @@ ___
### createTransaction
**createTransaction**(`data`): `Promise`<`string`\>
`**createTransaction**(data): Promise&#60;string&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`CreateGiftCardTransactionInput`](../types/CreateGiftCardTransactionInput.mdx)",
"type": "[CreateGiftCardTransactionInput](../types/CreateGiftCardTransactionInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -293,12 +293,12 @@ ___
#### Returns
`Promise`<`string`\>
Promise&#60;string&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`string`\\>",
"type": "Promise&#60;string&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -311,7 +311,7 @@ ___
### delete
**delete**(`giftCardId`): `Promise`<`void` \| [`GiftCard`](GiftCard.mdx)\>
`**delete**(giftCardId): Promise&#60;void \| [GiftCard](GiftCard.mdx)&#62;`
Deletes a gift card idempotently
@@ -331,12 +331,12 @@ Deletes a gift card idempotently
#### Returns
`Promise`<`void` \| [`GiftCard`](GiftCard.mdx)\>
Promise&#60;void \| [GiftCard](GiftCard.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void` \\| [`GiftCard`](GiftCard.mdx)\\>",
"type": "Promise&#60;void \\| [GiftCard](GiftCard.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the delete operation",
@@ -349,14 +349,14 @@ ___
### list
**list**(`selector?`, `config?`): `Promise`<[`GiftCard`](GiftCard.mdx)[]\>
`**list**(selector?, config?): Promise&#60;[GiftCard](GiftCard.mdx)[]&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`QuerySelector`](../types/QuerySelector.mdx)<[`GiftCard`](GiftCard.mdx)\\>",
"type": "[QuerySelector](../types/QuerySelector.mdx)&#60;[GiftCard](GiftCard.mdx)&#62;",
"description": "the query object for find",
"optional": false,
"defaultValue": "{}",
@@ -365,7 +365,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`GiftCard`](GiftCard.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[GiftCard](GiftCard.mdx)&#62;",
"description": "the configuration used to find the objects. contains relations, skip, and take.",
"optional": false,
"defaultValue": "",
@@ -376,12 +376,12 @@ ___
#### Returns
`Promise`<[`GiftCard`](GiftCard.mdx)[]\>
Promise&#60;[GiftCard](GiftCard.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`GiftCard`](GiftCard.mdx)[]\\>",
"type": "Promise&#60;[GiftCard](GiftCard.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
@@ -394,14 +394,14 @@ ___
### listAndCount
**listAndCount**(`selector?`, `config?`): `Promise`<[[`GiftCard`](GiftCard.mdx)[], `number`]\>
`**listAndCount**(selector?, config?): Promise&#60;[[GiftCard](GiftCard.mdx)[], number]&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`QuerySelector`](../types/QuerySelector.mdx)<[`GiftCard`](GiftCard.mdx)\\>",
"type": "[QuerySelector](../types/QuerySelector.mdx)&#60;[GiftCard](GiftCard.mdx)&#62;",
"description": "the query object for find",
"optional": false,
"defaultValue": "{}",
@@ -410,7 +410,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`GiftCard`](GiftCard.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[GiftCard](GiftCard.mdx)&#62;",
"description": "the configuration used to find the objects. contains relations, skip, and take.",
"optional": false,
"defaultValue": "",
@@ -421,12 +421,12 @@ ___
#### Returns
`Promise`<[[`GiftCard`](GiftCard.mdx)[], `number`]\>
Promise&#60;[[GiftCard](GiftCard.mdx)[], number]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`GiftCard`](GiftCard.mdx)[], `number`]\\>",
"type": "Promise&#60;[[GiftCard](GiftCard.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
@@ -439,7 +439,7 @@ ___
### retrieve
**retrieve**(`giftCardId`, `config?`): `Promise`<[`GiftCard`](GiftCard.mdx)\>
`**retrieve**(giftCardId, config?): Promise&#60;[GiftCard](GiftCard.mdx)&#62;`
Gets a gift card by id.
@@ -457,7 +457,7 @@ Gets a gift card by id.
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`GiftCard`](GiftCard.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[GiftCard](GiftCard.mdx)&#62;",
"description": "optional values to include with gift card query",
"optional": false,
"defaultValue": "{}",
@@ -468,12 +468,12 @@ Gets a gift card by id.
#### Returns
`Promise`<[`GiftCard`](GiftCard.mdx)\>
Promise&#60;[GiftCard](GiftCard.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`GiftCard`](GiftCard.mdx)\\>",
"type": "Promise&#60;[GiftCard](GiftCard.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the gift card",
@@ -486,7 +486,7 @@ ___
### retrieveByCode
**retrieveByCode**(`code`, `config?`): `Promise`<[`GiftCard`](GiftCard.mdx)\>
`**retrieveByCode**(code, config?): Promise&#60;[GiftCard](GiftCard.mdx)&#62;`
#### Parameters
@@ -502,7 +502,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`GiftCard`](GiftCard.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[GiftCard](GiftCard.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
@@ -513,12 +513,12 @@ ___
#### Returns
`Promise`<[`GiftCard`](GiftCard.mdx)\>
Promise&#60;[GiftCard](GiftCard.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`GiftCard`](GiftCard.mdx)\\>",
"type": "Promise&#60;[GiftCard](GiftCard.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -531,14 +531,14 @@ ___
### retrieve\_
`Protected` **retrieve_**(`selector`, `config?`): `Promise`<[`GiftCard`](GiftCard.mdx)\>
`Protected **retrieve_**(selector, config?): Promise&#60;[GiftCard](GiftCard.mdx)&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`Selector`](../types/Selector.mdx)<[`GiftCard`](GiftCard.mdx)\\>",
"type": "[Selector](../types/Selector.mdx)&#60;[GiftCard](GiftCard.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -547,7 +547,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`GiftCard`](GiftCard.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[GiftCard](GiftCard.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
@@ -558,12 +558,12 @@ ___
#### Returns
`Promise`<[`GiftCard`](GiftCard.mdx)\>
Promise&#60;[GiftCard](GiftCard.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`GiftCard`](GiftCard.mdx)\\>",
"type": "Promise&#60;[GiftCard](GiftCard.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -576,14 +576,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": "",
@@ -612,7 +612,7 @@ ___
### update
**update**(`giftCardId`, `update`): `Promise`<[`GiftCard`](GiftCard.mdx)\>
`**update**(giftCardId, update): Promise&#60;[GiftCard](GiftCard.mdx)&#62;`
Updates a giftCard.
@@ -630,7 +630,7 @@ Updates a giftCard.
},
{
"name": "update",
"type": "[`UpdateGiftCardInput`](../types/UpdateGiftCardInput.mdx)",
"type": "[UpdateGiftCardInput](../types/UpdateGiftCardInput.mdx)",
"description": "the data to update the giftCard with",
"optional": false,
"defaultValue": "",
@@ -641,12 +641,12 @@ Updates a giftCard.
#### Returns
`Promise`<[`GiftCard`](GiftCard.mdx)\>
Promise&#60;[GiftCard](GiftCard.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`GiftCard`](GiftCard.mdx)\\>",
"type": "Promise&#60;[GiftCard](GiftCard.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the update operation",
@@ -659,14 +659,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`GiftCardService`](GiftCardService.mdx)
`**withTransaction**(transactionManager?): [GiftCardService](GiftCardService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -677,12 +677,12 @@ ___
#### Returns
[`GiftCardService`](GiftCardService.mdx)
[GiftCardService](GiftCardService.mdx)
<ParameterTypes parameters={[
{
"name": "GiftCardService",
"type": "[`GiftCardService`](GiftCardService.mdx)",
"type": "[GiftCardService](GiftCardService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -695,7 +695,7 @@ ___
### generateCode
`Static` **generateCode**(): `string`
`Static **generateCode**(): string`
Generates a 16 character gift card code
@@ -719,10 +719,10 @@ ___
### resolveTaxRate
`Static` `Protected` **resolveTaxRate**(`giftCardTaxRate`, `region`): ``null`` \| `number`
`Static Protected **resolveTaxRate**(giftCardTaxRate, region): `null` \| number`
The tax_rate of the giftcard can depend on whether regions tax gift cards, an input
provided by the user or the tax rate. Based on these conditions, tax_rate changes.
The tax\_rate of the giftcard can depend on whether regions tax gift cards, an input
provided by the user or the tax rate. Based on these conditions, tax\_rate changes.
#### Parameters
@@ -738,7 +738,7 @@ provided by the user or the tax rate. Based on these conditions, tax_rate change
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "A region holds settings specific to a geographical location, including the currency, tax rates, and fulfillment and payment providers. A Region can consist of multiple countries to accomodate common shopping settings across countries.",
"optional": false,
"defaultValue": "",
@@ -753,7 +753,7 @@ provided by the user or the tax rate. Based on these conditions, tax_rate change
<ParameterTypes parameters={[
{
"name": "``null`` \\| number",
"name": "`null` \\| number",
"type": "``null`` \\| `number`",
"optional": true,
"defaultValue": "",