Class UserDefaultAdapter

Description

Default adapter for storing user information

Implements

Constructors

constructor

HandlerAndValidators

acceptInvitation activateUser changeUserEmail changeUserPassword checkUserPassword createAttachment createFollow createInvitation createUser createUserForAdmin createUserPreference deactivateUser deleteAttachment deleteFollow deleteInvitation deleteUser deleteUserPreference getAttachment getAttachmentUploadUrl getAvatarUploadUrl getUser getUserPreference listAttachments listAttachmentsForUser listFollowersForUser listFollows listFollowsForUser listInvitations listUserPreferences listUsers lockUser resetPassword sendResetPasswordEmail sendVerificationEmail unlockUser updateUser verifyChangeEmail verifyEmail

Properties

adapterName authSecrets dataServices dependencies opts

Constructors

constructor

HandlerAndValidators

acceptInvitation

acceptInvitation: HandlerAndValidators<{
    hasAllowedTypeId: undefined | Predicate;
    validBody: undefined | Predicate;
    validParams: undefined | Predicate;
} & Record<string, Predicate>>

Description

Accept invitation handler and validators

handler: acceptInvitationHandler

validators:

activateUser

activateUser: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Activate user handler and validators

handler: activateUserHandler

validators:

changeUserEmail

changeUserEmail: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Update user info handler and validators

handler: changeUserEmailHandler

validators:

changeUserPassword

changeUserPassword: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Update user info handler and validators

handler: changeUserPasswordHandler

validators:

checkUserPassword

checkUserPassword: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Check user password handler and validators

handler: checkUserPasswordHandler

validators:

createAttachment

createAttachment: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    isEmailVerified: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Create attachment handler and validators

handler: createAttachmentHandler

validators:

createFollow

createFollow: HandlerAndValidators<{
    authentication: undefined | Predicate;
    followExists: undefined | Predicate;
    isEmailVerified: undefined | Predicate;
    userExists: undefined | Predicate;
    validBody: undefined | Predicate;
    validFollower: undefined | Predicate;
    validFollowerId: undefined | Predicate;
    validFollowerType: undefined | Predicate;
} & Record<string, Predicate>>

Description

Create follow handler and validators

handler: createFollowHandler

validators:

createInvitation

createInvitation: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    featureEnabled: undefined | Predicate;
    isEmailNotTaken: undefined | Predicate;
    isEmailVerified: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Create invitation handler and validators

handler: createInvitationHandler

validators:

createUser

createUser: HandlerAndValidators<{
    hasAllowedTypeId: undefined | Predicate;
    validBody: undefined | Predicate;
    validCreateUserFields: undefined | Predicate;
} & Record<string, Predicate>>

Description

Create user handler and validators

handler: createUserHandler

validators:

createUserForAdmin

createUserForAdmin: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    validBody: undefined | Predicate;
    validCreateUserFields: undefined | Predicate;
} & Record<string, Predicate>>

Description

Create user for Admin handler and validators

handler: createUserForAdminHandler

validators:

createUserPreference

createUserPreference: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    isEmailVerified: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Create user preference handler and validators

handler: createUserPreferenceHandler

validators:

deactivateUser

deactivateUser: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Update user info handler and validators

handler: deactivateUserHandler

validators:

deleteAttachment

deleteAttachment: HandlerAndValidators<{
    attachmentExists: undefined | Predicate;
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    isEmailVerified: undefined | Predicate;
} & Record<string, Predicate>>

Description

Delete attachment handler and validators

handler: deleteAttachmentHandler

validators:

deleteFollow

deleteFollow: HandlerAndValidators<{
    authentication: undefined | Predicate;
    isEmailVerified: undefined | Predicate;
    userExists: undefined | Predicate;
    validBody: undefined | Predicate;
    validFollower: undefined | Predicate;
    validFollowerId: undefined | Predicate;
    validFollowerType: undefined | Predicate;
} & Record<string, Predicate>>

Description

Delete followers handler and validators

handler: deleteFollowHandler

validators:

deleteInvitation

deleteInvitation: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    isEmailVerified: undefined | Predicate;
    validParams: undefined | Predicate;
} & Record<string, Predicate>>

Description

Delete invitation handler and validators

handler: deleteInvitationHandler

validators:

deleteUser

deleteUser: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    validParams: undefined | Predicate;
} & Record<string, Predicate>>

Description

Delete user handler and validators

handler: deleteUserHandler

validators:

deleteUserPreference

deleteUserPreference: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    isEmailVerified: undefined | Predicate;
    preferenceBelongsToUser: undefined | Predicate;
} & Record<string, Predicate>>

Description

Delete user preference handler and validators

handler: deleteUserPreferenceHandler

validators:

getAttachment

getAttachment: HandlerAndValidators<{
    attachmentExists: undefined | Predicate;
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    isEmailVerified: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get attachment handler and validators

handler: getAttachmentHandler

validators:

getAttachmentUploadUrl

getAttachmentUploadUrl: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    isEmailVerified: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get attachment upload url handler and validators

handler: getAttachmentUploadUrlHandler

validators:

getAvatarUploadUrl

getAvatarUploadUrl: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get avatar upload url handler and validators

handler: getAvatarUploadHandler

validators:

getUser

getUser: HandlerAndValidators<{
    authentication: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get user by id handler and validators

handler: getUserHandler

validators:

getUserPreference

getUserPreference: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    isEmailVerified: undefined | Predicate;
    preferenceBelongsToUser: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get user preference by id handler and validators

handler: getUserPreferenceHandler

validators:

listAttachments

listAttachments: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    isEmailVerified: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get attachments handler and validators

handler: getAttachmentsHandler

validators:

listAttachmentsForUser

listAttachmentsForUser: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    isEmailVerified: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get attachments by user handler and validators

handler: listAttachmentsForUserHandler

validators:

listFollowersForUser

listFollowersForUser: HandlerAndValidators<{
    authentication: undefined | Predicate;
    isEmailVerified: undefined | Predicate;
    userExists: undefined | Predicate;
    validFollowerType: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get user followers handler and validators

handler: listFollowersForUserHandler

validators:

listFollows

listFollows: HandlerAndValidators<{
    authentication: undefined | Predicate;
    validFollowerType: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get follows handler and validators

handler: getFollowsHandler

validators:

listFollowsForUser

listFollowsForUser: HandlerAndValidators<{
    authentication: undefined | Predicate;
    isEmailVerified: undefined | Predicate;
    userExists: undefined | Predicate;
    validFollowerType: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get user follows handler and validators

handler: listFollowersForUser

validators:

Deprecated

use listFollows instead

listInvitations

listInvitations: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
} & Record<string, Predicate>>

Description

List invitations handler and validators

handler: listInvitationsHandler

validators:

listUserPreferences

listUserPreferences: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    isEmailVerified: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get user preferences handler and validators

handler: listUserPreferencesHandler

validators:

listUsers

listUsers: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
} & Record<string, Predicate>>

Description

List users handler and validators

handler: listUsersHandler

validators:

lockUser

lockUser: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    isEmailVerified: undefined | Predicate;
} & Record<string, Predicate>>

Description

Lock user handler and validators

handler: lockUserHandler

validators:

resetPassword

resetPassword: HandlerAndValidators<{
    validBody: undefined | Predicate;
    validPassword: undefined | Predicate;
} & Record<string, Predicate>>

Description

Reset password handler and validators

handler: resetPasswordHandler

validators:

sendResetPasswordEmail

sendResetPasswordEmail: HandlerAndValidators<{
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Send reset password email handler and validators

handler: sendResetPasswordEmailHandler

validators:

sendVerificationEmail

sendVerificationEmail: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
} & Record<string, Predicate>>

Description

Send verification email handler and validators

handler: sendVerificationEmailHandler

validators:

unlockUser

unlockUser: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    isEmailVerified: undefined | Predicate;
} & Record<string, Predicate>>

Description

Unlock user handler and validators

handler: unlockUserHandler

validators:

updateUser

updateUser: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    preventUserUpdateReviewStats: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Update user info handler and validators

handler: updateUserHandler

validators:

verifyChangeEmail

verifyChangeEmail: HandlerAndValidators<Record<string, Predicate>>

Description

Verify email handler and validators

handler: verifyChangeEmailHandler

verifyEmail

verifyEmail: HandlerAndValidators<Record<string, Predicate>>

Description

Verify email handler and validators

handler: verifyEmailHandler

Properties

adapterName

adapterName: string = ADAPTER_NAME

authSecrets

authSecrets: AuthSecrets

dataServices

dataServices: {
    attachment: AttachmentDefaultService;
    follower: FollowerDefaultService;
    invitation: InvitationDataService;
    preference: PreferenceDataService;
    user: UserDataService;
}

Type declaration

dependencies

dependencies: UserDefaultAdapterDependencies

opts

opts: Required<Omit<UserDefaultAdapterOptions, keyof AuthSecrets>> & {
    authenticate: AuthenticationFunction;
    collectionNames: Required<UserDefaultAdapterCollectionNames>;
    customStrategies: Required<undefined | UserDefaultAdapterStrategies>;
    emailConfig: Required<UserAdapterEmailConfig>;
}

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc