Skip to main content

Class: UserService

Provides layer to manipulate users.

Hierarchy

  • "medusa-interfaces"

    UserService

Constructors

constructor

new UserService(__namedParameters)

Parameters

NameType
__namedParametersUserServiceProps

Overrides

BaseService.constructor

Defined in

services/user.ts:36

Properties

eventBus_

Private eventBus_: EventBusService

Defined in

services/user.ts:32


manager_

Private manager_: EntityManager

Defined in

services/user.ts:33


transactionManager_

Private transactionManager_: EntityManager

Defined in

services/user.ts:34


userRepository_

Private userRepository_: typeof UserRepository

Defined in

services/user.ts:31


Events

Static Events: Object

Type declaration

NameType
PASSWORD_RESETstring

Defined in

services/user.ts:27

Methods

create

create(user, password): Promise<User>

Creates a user with username being validated. Fails if email is not a valid format.

Parameters

NameTypeDescription
userCreateUserInputthe user to create
passwordstringuser's password to hash

Returns

Promise<User>

the result of create

Defined in

services/user.ts:188


delete

delete(userId): Promise<null>

Deletes a user from a given user id.

Parameters

NameTypeDescription
userIdstringthe id of the user to delete. Must be castable as an ObjectId

Returns

Promise<null>

the result of the delete operation.

Defined in

services/user.ts:257


generateResetPasswordToken

generateResetPasswordToken(userId): Promise<string>

Generate a JSON Web token, that will be sent to a user, that wishes to reset password. The token will be signed with the users current password hash as a secret a long side a payload with userId and the expiry time for the token, which is always 15 minutes.

Parameters

NameTypeDescription
userIdstringthe id of the user to reset password for

Returns

Promise<string>

the generated JSON web token

Defined in

services/user.ts:311


hashPassword_

hashPassword_(password): Promise<string>

Hashes a password

Parameters

NameTypeDescription
passwordstringthe value to hash

Returns

Promise<string>

hashed password

Defined in

services/user.ts:176


list

list(selector, config?): Promise<User[]>

Parameters

NameTypeDescription
selectorFilterableUserPropsthe query object for find
configObjectthe configuration object for the query

Returns

Promise<User[]>

the result of the find operation

Defined in

services/user.ts:88


retrieve

retrieve(userId, config?): Promise<User>

Gets a user by id. Throws in case of DB Error and if user was not found.

Parameters

NameTypeDescription
userIdstringthe id of the user to get.
configFindConfig<User>query configs

Returns

Promise<User>

the user document.

Defined in

services/user.ts:100


retrieveByApiToken

retrieveByApiToken(apiToken, relations?): Promise<User>

Gets a user by api token. Throws in case of DB Error and if user was not found.

Parameters

NameTypeDefault valueDescription
apiTokenstringundefinedthe token of the user to get.
relationsstring[][]relations to include with the user

Returns

Promise<User>

the user document.

Defined in

services/user.ts:124


retrieveByEmail

retrieveByEmail(email, config?): Promise<User>

Gets a user by email. Throws in case of DB Error and if user was not found.

Parameters

NameTypeDescription
emailstringthe email of the user to get.
configFindConfig<User>query config

Returns

Promise<User>

the user document.

Defined in

services/user.ts:152


setPassword_

setPassword_(userId, password): Promise<User>

Sets a password for a user Fails if no user exists with userId and if the hashing of the new password does not work.

Parameters

NameTypeDescription
userIdstringthe userId to set password for
passwordstringthe old password to set

Returns

Promise<User>

the result of the update operation

Defined in

services/user.ts:282


update

update(userId, update): Promise<User>

Updates a user.

Parameters

NameTypeDescription
userIdstringid of the user to update
updateUpdateUserInputthe values to be updated on the user

Returns

Promise<User>

the result of create

Defined in

services/user.ts:216


validateEmail_

validateEmail_(email): string

Used to validate user email.

Parameters

NameTypeDescription
emailstringemail to validate

Returns

string

the validated email

Defined in

services/user.ts:70


withTransaction

withTransaction(transactionManager): UserService

Parameters

NameType
transactionManagerEntityManager

Returns

UserService

Defined in

services/user.ts:49