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/AuthService.mdx
+36 -36
View File
@@ -12,14 +12,14 @@ Can authenticate a user based on email password combination
### constructor
**new AuthService**(`«destructured»`)
`**new AuthService**(«destructured»)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "[`InjectedDependencies`](../types/InjectedDependencies-1.mdx)",
"type": "[InjectedDependencies](../types/InjectedDependencies-1.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -33,7 +33,7 @@ Can authenticate a user based on email password combination
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -51,7 +51,7 @@ Can authenticate a user based on email password combination
},
{
"name": "__moduleDeclaration__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -60,7 +60,7 @@ Can authenticate a user based on email password combination
},
{
"name": "customerService_",
"type": "[`CustomerService`](CustomerService.mdx)",
"type": "[CustomerService](CustomerService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -69,7 +69,7 @@ Can authenticate a user based on email password combination
},
{
"name": "manager_",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -78,7 +78,7 @@ Can authenticate a user based on email password combination
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"type": "`undefined` \\| EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -87,7 +87,7 @@ Can authenticate a user based on email password combination
},
{
"name": "userService_",
"type": "[`UserService`](UserService.mdx)",
"type": "[UserService](UserService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -100,16 +100,16 @@ Can authenticate a user based on email password combination
### activeManager\_
`Protected` `get` **activeManager_**(): `EntityManager`
`Protected get**activeManager_**(): EntityManager`
#### Returns
`EntityManager`
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
@@ -122,7 +122,7 @@ Can authenticate a user based on email password combination
### 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
@@ -154,7 +154,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": "",
@@ -163,7 +163,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": "",
@@ -172,7 +172,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": "",
@@ -183,12 +183,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",
@@ -201,7 +201,7 @@ ___
### authenticate
**authenticate**(`email`, `password`): `Promise`<[`AuthenticateResult`](../types/AuthenticateResult.mdx)\>
`**authenticate**(email, password): Promise&#60;[AuthenticateResult](../types/AuthenticateResult.mdx)&#62;`
Authenticates a given user based on an email, password combination. Uses
scrypt to match password with hashed value.
@@ -231,12 +231,12 @@ scrypt to match password with hashed value.
#### Returns
`Promise`<[`AuthenticateResult`](../types/AuthenticateResult.mdx)\>
Promise&#60;[AuthenticateResult](../types/AuthenticateResult.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`AuthenticateResult`](../types/AuthenticateResult.mdx)\\>",
"type": "Promise&#60;[AuthenticateResult](../types/AuthenticateResult.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "success: whether authentication succeeded\n user: the user document if authentication succeeded\n error: a string with the error message",
@@ -249,7 +249,7 @@ ___
### authenticateAPIToken
**authenticateAPIToken**(`token`): `Promise`<[`AuthenticateResult`](../types/AuthenticateResult.mdx)\>
`**authenticateAPIToken**(token): Promise&#60;[AuthenticateResult](../types/AuthenticateResult.mdx)&#62;`
Authenticates a given user with an API token
@@ -259,7 +259,7 @@ Authenticates a given user with an API token
{
"name": "token",
"type": "`string`",
"description": "the api_token of the user to authenticate",
"description": "the api\\_token of the user to authenticate",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -269,12 +269,12 @@ Authenticates a given user with an API token
#### Returns
`Promise`<[`AuthenticateResult`](../types/AuthenticateResult.mdx)\>
Promise&#60;[AuthenticateResult](../types/AuthenticateResult.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`AuthenticateResult`](../types/AuthenticateResult.mdx)\\>",
"type": "Promise&#60;[AuthenticateResult](../types/AuthenticateResult.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "success: whether authentication succeeded\n user: the user document if authentication succeeded\n error: a string with the error message",
@@ -287,7 +287,7 @@ ___
### authenticateCustomer
**authenticateCustomer**(`email`, `password`): `Promise`<[`AuthenticateResult`](../types/AuthenticateResult.mdx)\>
`**authenticateCustomer**(email, password): Promise&#60;[AuthenticateResult](../types/AuthenticateResult.mdx)&#62;`
Authenticates a customer based on an email, password combination. Uses
scrypt to match password with hashed value.
@@ -317,12 +317,12 @@ scrypt to match password with hashed value.
#### Returns
`Promise`<[`AuthenticateResult`](../types/AuthenticateResult.mdx)\>
Promise&#60;[AuthenticateResult](../types/AuthenticateResult.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`AuthenticateResult`](../types/AuthenticateResult.mdx)\\>",
"type": "Promise&#60;[AuthenticateResult](../types/AuthenticateResult.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "success: whether authentication succeeded\n customer: the customer document if authentication succeded\n error: a string with the error message",
@@ -335,7 +335,7 @@ ___
### comparePassword\_
`Protected` **comparePassword_**(`password`, `hash`): `Promise`<`boolean`\>
`Protected **comparePassword_**(password, hash): Promise&#60;boolean&#62;`
Verifies if a password is valid given the provided password hash
@@ -364,12 +364,12 @@ Verifies if a password is valid given the provided password hash
#### Returns
`Promise`<`boolean`\>
Promise&#60;boolean&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`boolean`\\>",
"type": "Promise&#60;boolean&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the comparison",
@@ -382,14 +382,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": "",
@@ -418,14 +418,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`AuthService`](AuthService.mdx)
`**withTransaction**(transactionManager?): [AuthService](AuthService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -436,12 +436,12 @@ ___
#### Returns
[`AuthService`](AuthService.mdx)
[AuthService](AuthService.mdx)
<ParameterTypes parameters={[
{
"name": "AuthService",
"type": "[`AuthService`](AuthService.mdx)",
"type": "[AuthService](AuthService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",