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

104
www/apps/docs/content/references/services/classes/OauthService.mdx
View File

@@ -10,14 +10,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### constructor
**new OauthService**(`cradle`)
`**new OauthService**(cradle)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "cradle",
"type": "[`InjectedDependencies`](../types/InjectedDependencies-18.mdx)",
"type": "[InjectedDependencies](../types/InjectedDependencies-18.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": "container_",
"type": "[`InjectedDependencies`](../types/InjectedDependencies-18.mdx)",
"type": "[InjectedDependencies](../types/InjectedDependencies-18.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "eventBus_",
"type": "[`EventBusService`](EventBusService.mdx)",
"type": "[EventBusService](EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "manager_",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "oauthRepository_",
"type": "`Repository`<[`Oauth`](Oauth.mdx)\\>",
"type": "Repository&#60;[Oauth](Oauth.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -94,7 +94,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,14 +235,14 @@ ___
### create
**create**(`data`): `Promise`<[`Oauth`](Oauth.mdx)\>
`**create**(data): Promise&#60;[Oauth](Oauth.mdx)&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`CreateOauthInput`](../types/CreateOauthInput.mdx)",
"type": "[CreateOauthInput](../types/CreateOauthInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -253,12 +253,12 @@ ___
#### Returns
`Promise`<[`Oauth`](Oauth.mdx)\>
Promise&#60;[Oauth](Oauth.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Oauth`](Oauth.mdx)\\>",
"type": "Promise&#60;[Oauth](Oauth.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -271,7 +271,7 @@ ___
### generateToken
**generateToken**(`appName`, `code`, `state`): `Promise`<[`Oauth`](Oauth.mdx)\>
`**generateToken**(appName, code, state): Promise&#60;[Oauth](Oauth.mdx)&#62;`
#### Parameters
@@ -307,12 +307,12 @@ ___
#### Returns
`Promise`<[`Oauth`](Oauth.mdx)\>
Promise&#60;[Oauth](Oauth.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Oauth`](Oauth.mdx)\\>",
"type": "Promise&#60;[Oauth](Oauth.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -325,14 +325,14 @@ ___
### list
**list**(`selector`): `Promise`<[`Oauth`](Oauth.mdx)[]\>
`**list**(selector): Promise&#60;[Oauth](Oauth.mdx)[]&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`Selector`](../types/Selector.mdx)<[`Oauth`](Oauth.mdx)\\>",
"type": "[Selector](../types/Selector.mdx)&#60;[Oauth](Oauth.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -343,12 +343,12 @@ ___
#### Returns
`Promise`<[`Oauth`](Oauth.mdx)[]\>
Promise&#60;[Oauth](Oauth.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Oauth`](Oauth.mdx)[]\\>",
"type": "Promise&#60;[Oauth](Oauth.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -361,7 +361,7 @@ ___
### refreshToken
**refreshToken**(`appName`): `Promise`<[`Oauth`](Oauth.mdx)\>
`**refreshToken**(appName): Promise&#60;[Oauth](Oauth.mdx)&#62;`
#### Parameters
@@ -379,12 +379,12 @@ ___
#### Returns
`Promise`<[`Oauth`](Oauth.mdx)\>
Promise&#60;[Oauth](Oauth.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Oauth`](Oauth.mdx)\\>",
"type": "Promise&#60;[Oauth](Oauth.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -397,14 +397,14 @@ ___
### registerOauthApp
**registerOauthApp**(`appDetails`): `Promise`<[`Oauth`](Oauth.mdx)\>
`**registerOauthApp**(appDetails): Promise&#60;[Oauth](Oauth.mdx)&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "appDetails",
"type": "[`CreateOauthInput`](../types/CreateOauthInput.mdx)",
"type": "[CreateOauthInput](../types/CreateOauthInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -415,12 +415,12 @@ ___
#### Returns
`Promise`<[`Oauth`](Oauth.mdx)\>
Promise&#60;[Oauth](Oauth.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Oauth`](Oauth.mdx)\\>",
"type": "Promise&#60;[Oauth](Oauth.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -433,7 +433,7 @@ ___
### retrieve
**retrieve**(`oauthId`): `Promise`<[`Oauth`](Oauth.mdx)\>
`**retrieve**(oauthId): Promise&#60;[Oauth](Oauth.mdx)&#62;`
#### Parameters
@@ -451,12 +451,12 @@ ___
#### Returns
`Promise`<[`Oauth`](Oauth.mdx)\>
Promise&#60;[Oauth](Oauth.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Oauth`](Oauth.mdx)\\>",
"type": "Promise&#60;[Oauth](Oauth.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -469,7 +469,7 @@ ___
### retrieveByName
**retrieveByName**(`appName`): `Promise`<[`Oauth`](Oauth.mdx)\>
`**retrieveByName**(appName): Promise&#60;[Oauth](Oauth.mdx)&#62;`
#### Parameters
@@ -487,12 +487,12 @@ ___
#### Returns
`Promise`<[`Oauth`](Oauth.mdx)\>
Promise&#60;[Oauth](Oauth.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Oauth`](Oauth.mdx)\\>",
"type": "Promise&#60;[Oauth](Oauth.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -505,14 +505,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": "",
@@ -541,7 +541,7 @@ ___
### update
**update**(`id`, `update`): `Promise`<[`Oauth`](Oauth.mdx)\>
`**update**(id, update): Promise&#60;[Oauth](Oauth.mdx)&#62;`
#### Parameters
@@ -557,7 +557,7 @@ ___
},
{
"name": "update",
"type": "[`UpdateOauthInput`](../types/UpdateOauthInput.mdx)",
"type": "[UpdateOauthInput](../types/UpdateOauthInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -568,12 +568,12 @@ ___
#### Returns
`Promise`<[`Oauth`](Oauth.mdx)\>
Promise&#60;[Oauth](Oauth.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Oauth`](Oauth.mdx)\\>",
"type": "Promise&#60;[Oauth](Oauth.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -586,14 +586,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`OauthService`](OauthService.mdx)
`**withTransaction**(transactionManager?): [OauthService](OauthService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -604,12 +604,12 @@ ___
#### Returns
[`OauthService`](OauthService.mdx)
[OauthService](OauthService.mdx)
<ParameterTypes parameters={[
{
"name": "Oauth",
"type": "[`OauthService`](OauthService.mdx)",
"type": "[OauthService](OauthService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",