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

120
www/apps/docs/content/references/services/classes/NotificationService.mdx
View File

@@ -10,14 +10,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### constructor
**new NotificationService**(`container`)
`**new NotificationService**(container)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "container",
"type": "[`InjectedDependencies`](../types/InjectedDependencies-17.mdx)",
"type": "[InjectedDependencies](../types/InjectedDependencies-17.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": "",
@@ -67,7 +67,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "container_",
"type": "[`InjectedDependencies`](../types/InjectedDependencies-17.mdx) & {}",
"type": "[InjectedDependencies](../types/InjectedDependencies-17.mdx) & `&#123;&#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "logger_",
"type": "[`Logger`](../types/Logger-1.mdx)",
"type": "[Logger](../types/Logger-1.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "manager_",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -94,7 +94,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "notificationProviderRepository_",
"type": "`Repository`<[`NotificationProvider`](NotificationProvider.mdx)\\>",
"type": "Repository&#60;[NotificationProvider](NotificationProvider.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -103,7 +103,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "notificationRepository_",
"type": "`Repository`<[`Notification`](Notification.mdx)\\>",
"type": "Repository&#60;[Notification](Notification.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -121,7 +121,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"type": "`undefined` \\| EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -134,16 +134,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": "",
@@ -156,7 +156,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
@@ -188,7 +188,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": "",
@@ -197,7 +197,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": "",
@@ -206,7 +206,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": "",
@@ -217,12 +217,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",
@@ -235,7 +235,7 @@ ___
### handleEvent
**handleEvent**(`eventName`, `data`): `Promise`<`undefined` \| `void` \| [`Notification`](Notification.mdx)[]\>
`**handleEvent**(eventName, data): Promise&#60;undefined \| void \| [Notification](Notification.mdx)[]&#62;`
Handles an event by relaying the event data to the subscribing providers.
The result of the notification send will be persisted in the database in
@@ -255,7 +255,7 @@ order to allow for resends. Will log any errors that are encountered.
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "the data the event was sent with",
"optional": false,
"defaultValue": "",
@@ -266,12 +266,12 @@ order to allow for resends. Will log any errors that are encountered.
#### Returns
`Promise`<`undefined` \| `void` \| [`Notification`](Notification.mdx)[]\>
Promise&#60;undefined \| void \| [Notification](Notification.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`undefined` \\| `void` \\| [`Notification`](Notification.mdx)[]\\>",
"type": "Promise&#60;undefined \\| void \\| [Notification](Notification.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of notification subscribed",
@@ -284,7 +284,7 @@ ___
### list
**list**(`selector`, `config?`): `Promise`<[`Notification`](Notification.mdx)[]\>
`**list**(selector, config?): Promise&#60;[Notification](Notification.mdx)[]&#62;`
Retrieves a list of notifications.
@@ -293,7 +293,7 @@ Retrieves a list of notifications.
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`Selector`](../types/Selector.mdx)<[`Notification`](Notification.mdx)\\>",
"type": "[Selector](../types/Selector.mdx)&#60;[Notification](Notification.mdx)&#62;",
"description": "the params to select the notifications by.",
"optional": false,
"defaultValue": "",
@@ -302,7 +302,7 @@ Retrieves a list of notifications.
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`Notification`](Notification.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[Notification](Notification.mdx)&#62;",
"description": "the configuration to apply to the query",
"optional": false,
"defaultValue": "",
@@ -313,12 +313,12 @@ Retrieves a list of notifications.
#### Returns
`Promise`<[`Notification`](Notification.mdx)[]\>
Promise&#60;[Notification](Notification.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Notification`](Notification.mdx)[]\\>",
"type": "Promise&#60;[Notification](Notification.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the notifications that satisfy the query.",
@@ -331,7 +331,7 @@ ___
### listAndCount
**listAndCount**(`selector`, `config?`): `Promise`<[[`Notification`](Notification.mdx)[], `number`]\>
`**listAndCount**(selector, config?): Promise&#60;[[Notification](Notification.mdx)[], number]&#62;`
Retrieves a list of notifications and total count.
@@ -340,7 +340,7 @@ Retrieves a list of notifications and total count.
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`Selector`](../types/Selector.mdx)<[`Notification`](Notification.mdx)\\>",
"type": "[Selector](../types/Selector.mdx)&#60;[Notification](Notification.mdx)&#62;",
"description": "the params to select the notifications by.",
"optional": false,
"defaultValue": "",
@@ -349,7 +349,7 @@ Retrieves a list of notifications and total count.
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`Notification`](Notification.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[Notification](Notification.mdx)&#62;",
"description": "the configuration to apply to the query",
"optional": false,
"defaultValue": "",
@@ -360,12 +360,12 @@ Retrieves a list of notifications and total count.
#### Returns
`Promise`<[[`Notification`](Notification.mdx)[], `number`]\>
Promise&#60;[[Notification](Notification.mdx)[], number]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`Notification`](Notification.mdx)[], `number`]\\>",
"type": "Promise&#60;[[Notification](Notification.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "the notifications that satisfy the query as well as the count.",
@@ -378,7 +378,7 @@ ___
### registerAttachmentGenerator
**registerAttachmentGenerator**(`service`): `void`
`**registerAttachmentGenerator**(service): void`
Registers an attachment generator to the service. The generator can be
used to generate on demand invoices or other documents.
@@ -417,7 +417,7 @@ ___
### registerInstalledProviders
**registerInstalledProviders**(`providerIds`): `Promise`<`void`\>
`**registerInstalledProviders**(providerIds): Promise&#60;void&#62;`
Takes a list of notification provider ids and persists them in the database.
@@ -437,12 +437,12 @@ Takes a list of notification provider ids and persists them in the database.
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -455,7 +455,7 @@ ___
### resend
**resend**(`id`, `config?`): `Promise`<[`Notification`](Notification.mdx)\>
`**resend**(id, config?): Promise&#60;[Notification](Notification.mdx)&#62;`
Resends a notification by retrieving a prior notification and calling the
underlying provider's resendNotification method.
@@ -474,7 +474,7 @@ underlying provider's resendNotification method.
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`Notification`](Notification.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[Notification](Notification.mdx)&#62;",
"description": "any configuration that might override the previous send",
"optional": false,
"defaultValue": "{}",
@@ -485,12 +485,12 @@ underlying provider's resendNotification method.
#### Returns
`Promise`<[`Notification`](Notification.mdx)\>
Promise&#60;[Notification](Notification.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Notification`](Notification.mdx)\\>",
"type": "Promise&#60;[Notification](Notification.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the newly created notification",
@@ -503,7 +503,7 @@ ___
### retrieve
**retrieve**(`id`, `config?`): `Promise`<[`Notification`](Notification.mdx)\>
`**retrieve**(id, config?): Promise&#60;[Notification](Notification.mdx)&#62;`
Retrieves a notification with a given id
@@ -521,7 +521,7 @@ Retrieves a notification with a given id
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`Notification`](Notification.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[Notification](Notification.mdx)&#62;",
"description": "the configuration to apply to the query",
"optional": false,
"defaultValue": "{}",
@@ -532,12 +532,12 @@ Retrieves a notification with a given id
#### Returns
`Promise`<[`Notification`](Notification.mdx)\>
Promise&#60;[Notification](Notification.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Notification`](Notification.mdx)\\>",
"type": "Promise&#60;[Notification](Notification.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the notification",
@@ -550,9 +550,9 @@ ___
### retrieveProvider\_
`Protected` **retrieveProvider_**(`id`): [`AbstractNotificationService`](AbstractNotificationService.mdx)
`Protected **retrieveProvider_**(id): [AbstractNotificationService](AbstractNotificationService.mdx)`
Finds a provider with a given id. Will throw a NOT_FOUND error if the
Finds a provider with a given id. Will throw a NOT\_FOUND error if the
resolution fails.
#### Parameters
@@ -571,12 +571,12 @@ resolution fails.
#### Returns
[`AbstractNotificationService`](AbstractNotificationService.mdx)
[AbstractNotificationService](AbstractNotificationService.mdx)
<ParameterTypes parameters={[
{
"name": "AbstractNotificationService",
"type": "[`AbstractNotificationService`](AbstractNotificationService.mdx)",
"type": "[AbstractNotificationService](AbstractNotificationService.mdx)",
"optional": false,
"defaultValue": "",
"description": "the notification provider",
@@ -589,7 +589,7 @@ ___
### send
**send**(`event`, `eventData`, `providerId`): `Promise`<`undefined` \| [`Notification`](Notification.mdx)\>
`**send**(event, eventData, providerId): Promise&#60;undefined \| [Notification](Notification.mdx)&#62;`
Sends a notification, by calling the given provider's sendNotification
method. Persists the Notification in the database.
@@ -608,7 +608,7 @@ method. Persists the Notification in the database.
},
{
"name": "eventData",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "the data the event was sent with",
"optional": false,
"defaultValue": "",
@@ -628,12 +628,12 @@ method. Persists the Notification in the database.
#### Returns
`Promise`<`undefined` \| [`Notification`](Notification.mdx)\>
Promise&#60;undefined \| [Notification](Notification.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`undefined` \\| [`Notification`](Notification.mdx)\\>",
"type": "Promise&#60;undefined \\| [Notification](Notification.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the created notification",
@@ -646,14 +646,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": "",
@@ -682,7 +682,7 @@ ___
### subscribe
**subscribe**(`eventName`, `providerId`): `void`
`**subscribe**(eventName, providerId): void`
Subscribes a given provider to an event.
@@ -729,14 +729,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`NotificationService`](NotificationService.mdx)
`**withTransaction**(transactionManager?): [NotificationService](NotificationService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -747,12 +747,12 @@ ___
#### Returns
[`NotificationService`](NotificationService.mdx)
[NotificationService](NotificationService.mdx)
<ParameterTypes parameters={[
{
"name": "NotificationService",
"type": "[`NotificationService`](NotificationService.mdx)",
"type": "[NotificationService](NotificationService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",