@saflib/identity-db

---

Variable: emailAuthDb

const emailAuthDb: object

Database queries for the email_auth table. The email_auth table contains email authentication information for the users.

Type declaration

clearForgotPasswordToken()

clearForgotPasswordToken: (dbKey, userId) => Promise<ReturnsError<{ email: string; forgotPasswordToken: null | string; forgotPasswordTokenExpiresAt: null | Date; passwordHash: unknown; userId: number; verificationToken: null | string; verificationTokenExpiresAt: null | Date; verifiedAt: null | Date; }, EmailAuthNotFoundError>>

Parameters

Parameter	Type
dbKey	symbol
userId	number

Returns

Promise<ReturnsError<{ email: string; forgotPasswordToken: null | string; forgotPasswordTokenExpiresAt: null | Date; passwordHash: unknown; userId: number; verificationToken: null | string; verificationTokenExpiresAt: null | Date; verifiedAt: null | Date; }, EmailAuthNotFoundError>>

create()

create: (dbKey, auth) => Promise<{ email: string; forgotPasswordToken: null | string; forgotPasswordTokenExpiresAt: null | Date; passwordHash: unknown; userId: number; verificationToken: null | string; verificationTokenExpiresAt: null | Date; verifiedAt: null | Date; }>

Parameters

Parameter	Type
dbKey	symbol
auth	{ email: string; forgotPasswordToken?: null | string; forgotPasswordTokenExpiresAt?: null | Date; passwordHash: unknown; userId: number; verificationToken?: null | string; verificationTokenExpiresAt?: null | Date; verifiedAt?: null | Date; }
auth.email	string
auth.forgotPasswordToken?	null | string
auth.forgotPasswordTokenExpiresAt?	null | Date
auth.passwordHash	unknown
auth.userId	number
auth.verificationToken?	null | string
auth.verificationTokenExpiresAt?	null | Date
auth.verifiedAt?	null | Date

Returns

Promise<{ email: string; forgotPasswordToken: null | string; forgotPasswordTokenExpiresAt: null | Date; passwordHash: unknown; userId: number; verificationToken: null | string; verificationTokenExpiresAt: null | Date; verifiedAt: null | Date; }>

getByEmail()

getByEmail: (dbKey, email) => Promise<ReturnsError<{ email: string; forgotPasswordToken: null | string; forgotPasswordTokenExpiresAt: null | Date; passwordHash: unknown; userId: number; verificationToken: null | string; verificationTokenExpiresAt: null | Date; verifiedAt: null | Date; }, EmailAuthNotFoundError>>

Parameters

Parameter	Type
dbKey	symbol
email	string

Returns

Promise<ReturnsError<{ email: string; forgotPasswordToken: null | string; forgotPasswordTokenExpiresAt: null | Date; passwordHash: unknown; userId: number; verificationToken: null | string; verificationTokenExpiresAt: null | Date; verifiedAt: null | Date; }, EmailAuthNotFoundError>>

getByForgotPasswordToken()

getByForgotPasswordToken: (dbKey, token) => Promise<ReturnsError<{ email: string; forgotPasswordToken: null | string; forgotPasswordTokenExpiresAt: null | Date; passwordHash: unknown; userId: number; verificationToken: null | string; verificationTokenExpiresAt: null | Date; verifiedAt: null | Date; }, TokenNotFoundError>>

Parameters

Parameter	Type
dbKey	symbol
token	string

Returns

Promise<ReturnsError<{ email: string; forgotPasswordToken: null | string; forgotPasswordTokenExpiresAt: null | Date; passwordHash: unknown; userId: number; verificationToken: null | string; verificationTokenExpiresAt: null | Date; verifiedAt: null | Date; }, TokenNotFoundError>>

getByVerificationToken()

getByVerificationToken: (dbKey, token) => Promise<ReturnsError<{ email: string; forgotPasswordToken: null | string; forgotPasswordTokenExpiresAt: null | Date; passwordHash: unknown; userId: number; verificationToken: null | string; verificationTokenExpiresAt: null | Date; verifiedAt: null | Date; }, VerificationTokenNotFoundError>>

Parameters

Parameter	Type
dbKey	symbol
token	string

Returns

Promise<ReturnsError<{ email: string; forgotPasswordToken: null | string; forgotPasswordTokenExpiresAt: null | Date; passwordHash: unknown; userId: number; verificationToken: null | string; verificationTokenExpiresAt: null | Date; verifiedAt: null | Date; }, VerificationTokenNotFoundError>>

getEmailAuthByUserIds()

getEmailAuthByUserIds: (dbKey, ids) => Promise<object[]>

Parameters

Parameter	Type
dbKey	symbol
ids	number[]

Returns

Promise<object[]>

updateEmail()

updateEmail: (dbKey, userId, newEmail) => Promise<ReturnsError<UpdateEmailResult, EmailAuthNotFoundError | EmailTakenError>>

Parameters

Parameter	Type
dbKey	symbol
userId	number
newEmail	string

Returns

Promise<ReturnsError<UpdateEmailResult, EmailAuthNotFoundError | EmailTakenError>>

updateForgotPasswordToken()

updateForgotPasswordToken: (dbKey, userId, forgotPasswordToken, forgotPasswordTokenExpiresAt) => Promise<ReturnsError<{ email: string; forgotPasswordToken: null | string; forgotPasswordTokenExpiresAt: null | Date; passwordHash: unknown; userId: number; verificationToken: null | string; verificationTokenExpiresAt: null | Date; verifiedAt: null | Date; }, EmailAuthNotFoundError>>

Parameters

Parameter	Type
dbKey	symbol
userId	number
forgotPasswordToken	null | string
forgotPasswordTokenExpiresAt	null | Date

Returns

Promise<ReturnsError<{ email: string; forgotPasswordToken: null | string; forgotPasswordTokenExpiresAt: null | Date; passwordHash: unknown; userId: number; verificationToken: null | string; verificationTokenExpiresAt: null | Date; verifiedAt: null | Date; }, EmailAuthNotFoundError>>

updatePassword()

updatePassword: (dbKey, userId, passwordHash) => Promise<ReturnsError<{ email: string; forgotPasswordToken: null | string; forgotPasswordTokenExpiresAt: null | Date; passwordHash: unknown; userId: number; verificationToken: null | string; verificationTokenExpiresAt: null | Date; verifiedAt: null | Date; }, EmailAuthNotFoundError>>

Parameters

Parameter	Type
dbKey	symbol
userId	number
passwordHash	Uint8Array

Returns

Promise<ReturnsError<{ email: string; forgotPasswordToken: null | string; forgotPasswordTokenExpiresAt: null | Date; passwordHash: unknown; userId: number; verificationToken: null | string; verificationTokenExpiresAt: null | Date; verifiedAt: null | Date; }, EmailAuthNotFoundError>>

updatePasswordHash()

updatePasswordHash: (dbKey, userId, passwordHash) => Promise<ReturnsError<{ email: string; forgotPasswordToken: null | string; forgotPasswordTokenExpiresAt: null | Date; passwordHash: unknown; userId: number; verificationToken: null | string; verificationTokenExpiresAt: null | Date; verifiedAt: null | Date; }, EmailAuthNotFoundError>>

Parameters

Parameter	Type
dbKey	symbol
userId	number
passwordHash	Uint8Array

Returns

Promise<ReturnsError<{ email: string; forgotPasswordToken: null | string; forgotPasswordTokenExpiresAt: null | Date; passwordHash: unknown; userId: number; verificationToken: null | string; verificationTokenExpiresAt: null | Date; verifiedAt: null | Date; }, EmailAuthNotFoundError>>

updateVerificationToken()

updateVerificationToken: (dbKey, userId, verificationToken, verificationTokenExpiresAt) => Promise<ReturnsError<{ email: string; forgotPasswordToken: null | string; forgotPasswordTokenExpiresAt: null | Date; passwordHash: unknown; userId: number; verificationToken: null | string; verificationTokenExpiresAt: null | Date; verifiedAt: null | Date; }, EmailAuthNotFoundError>>

Parameters

Parameter	Type
dbKey	symbol
userId	number
verificationToken	string
verificationTokenExpiresAt	Date

Returns

Promise<ReturnsError<{ email: string; forgotPasswordToken: null | string; forgotPasswordTokenExpiresAt: null | Date; passwordHash: unknown; userId: number; verificationToken: null | string; verificationTokenExpiresAt: null | Date; verifiedAt: null | Date; }, EmailAuthNotFoundError>>

verifyEmail()

verifyEmail: (dbKey, userId) => Promise<ReturnsError<{ email: string; forgotPasswordToken: null | string; forgotPasswordTokenExpiresAt: null | Date; passwordHash: unknown; userId: number; verificationToken: null | string; verificationTokenExpiresAt: null | Date; verifiedAt: null | Date; }, EmailAuthNotFoundError>>

Parameters

Parameter	Type
dbKey	symbol
userId	number

Returns

Promise<ReturnsError<{ email: string; forgotPasswordToken: null | string; forgotPasswordTokenExpiresAt: null | Date; passwordHash: unknown; userId: number; verificationToken: null | string; verificationTokenExpiresAt: null | Date; verifiedAt: null | Date; }, EmailAuthNotFoundError>>