02d5c1da88
* generated new services reference * changed from automatic push to automated pull request * updated typedoc, regenerated JS Client reference * regenerated the reference after updating typedoc * added action for js client
7.2 KiB
Class: AuthService
Can authenticate a user based on email password combination
Hierarchy
-
TransactionBaseService<AuthService>↳
AuthService
Constructors
constructor
• new AuthService(__namedParameters)
Parameters
| Name | Type |
|---|---|
__namedParameters |
InjectedDependencies |
Overrides
TransactionBaseService<AuthService>.constructor
Defined in
packages/medusa/src/services/auth.ts:25
Properties
configModule
• Protected Optional Readonly configModule: Record<string, unknown>
Inherited from
TransactionBaseService.configModule
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:13
container
• Protected Readonly container: unknown
Inherited from
TransactionBaseService.container
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:12
customerService_
• Protected Readonly customerService_: CustomerService
Defined in
packages/medusa/src/services/auth.ts:23
manager_
• Protected manager_: EntityManager
Overrides
TransactionBaseService.manager_
Defined in
packages/medusa/src/services/auth.ts:20
transactionManager_
• Protected transactionManager_: undefined | EntityManager
Overrides
TransactionBaseService.transactionManager_
Defined in
packages/medusa/src/services/auth.ts:21
userService_
• Protected Readonly userService_: UserService
Defined in
packages/medusa/src/services/auth.ts:22
Methods
atomicPhase_
▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>
Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.
Type parameters
| Name |
|---|
TResult |
TError |
Parameters
| Name | Type | Description |
|---|---|---|
work |
(transactionManager: EntityManager) => Promise<TResult> |
the transactional work to be done |
isolationOrErrorHandler? |
IsolationLevel | (error: TError) => Promise<void | TResult> |
the isolation level to be used for the work. |
maybeErrorHandlerOrDontFail? |
(error: TError) => Promise<void | TResult> |
Potential error handler |
Returns
Promise<TResult>
the result of the transactional work
Inherited from
TransactionBaseService.atomicPhase_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:53
authenticate
▸ authenticate(email, password): Promise<AuthenticateResult>
Authenticates a given user based on an email, password combination. Uses scrypt to match password with hashed value.
Parameters
| Name | Type | Description |
|---|---|---|
email |
string |
the email of the user |
password |
string |
the password of the user |
Returns
Promise<AuthenticateResult>
success: whether authentication succeeded user: the user document if authentication succeded error: a string with the error message
Defined in
packages/medusa/src/services/auth.ts:98
authenticateAPIToken
▸ authenticateAPIToken(token): Promise<AuthenticateResult>
Authenticates a given user with an API token
Parameters
| Name | Type | Description |
|---|---|---|
token |
string |
the api_token of the user to authenticate |
Returns
Promise<AuthenticateResult>
success: whether authentication succeeded user: the user document if authentication succeded error: a string with the error message
Defined in
packages/medusa/src/services/auth.ts:55
authenticateCustomer
▸ authenticateCustomer(email, password): Promise<AuthenticateResult>
Authenticates a customer based on an email, password combination. Uses scrypt to match password with hashed value.
Parameters
| Name | Type | Description |
|---|---|---|
email |
string |
the email of the user |
password |
string |
the password of the user |
Returns
Promise<AuthenticateResult>
success: whether authentication succeeded user: the user document if authentication succeded error: a string with the error message
Defined in
packages/medusa/src/services/auth.ts:147
comparePassword_
▸ Protected comparePassword_(password, hash): Promise<boolean>
Verifies if a password is valid given the provided password hash
Parameters
| Name | Type | Description |
|---|---|---|
password |
string |
the raw password to check |
hash |
string |
the hash to compare against |
Returns
Promise<boolean>
the result of the comparison
Defined in
packages/medusa/src/services/auth.ts:39
shouldRetryTransaction_
▸ Protected shouldRetryTransaction_(err): boolean
Parameters
| Name | Type |
|---|---|
err |
Record<string, unknown> | { code: string } |
Returns
boolean
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:34
withTransaction
▸ withTransaction(transactionManager?): AuthService
Parameters
| Name | Type |
|---|---|
transactionManager? |
EntityManager |
Returns
Inherited from
TransactionBaseService.withTransaction
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:16