@saflib/identity-db

---

Variable: usersDb

const usersDb: object

Database queries for the users table. The users table contains profile information about the users, similar to the OIDC Standard Claims.

Type declaration

create()

create: (dbKey, user) => Promise<ReturnsError<{ createdAt: Date; email: string; emailVerified: null | boolean; familyName: null | string; givenName: null | string; id: number; lastLoginAt: null | Date; name: null | string; }, EmailConflictError>>

Parameters

Parameter	Type
dbKey	symbol
user	NewUser

Returns

Promise<ReturnsError<{ createdAt: Date; email: string; emailVerified: null | boolean; familyName: null | string; givenName: null | string; id: number; lastLoginAt: null | Date; name: null | string; }, EmailConflictError>>

getAll()

getAll: (dbKey) => Promise<object[]>

Parameters

Parameter	Type
dbKey	symbol

Returns

Promise<object[]>

getByEmail()

getByEmail: (dbKey, email) => Promise<ReturnsError<{ createdAt: Date; email: string; emailVerified: null | boolean; familyName: null | string; givenName: null | string; id: number; lastLoginAt: null | Date; name: null | string; }, UserNotFoundError>>

Parameters

Parameter	Type
dbKey	symbol
email	string

Returns

Promise<ReturnsError<{ createdAt: Date; email: string; emailVerified: null | boolean; familyName: null | string; givenName: null | string; id: number; lastLoginAt: null | Date; name: null | string; }, UserNotFoundError>>

getById()

getById: (dbKey, id) => Promise<ReturnsError<{ createdAt: Date; email: string; emailVerified: null | boolean; familyName: null | string; givenName: null | string; id: number; lastLoginAt: null | Date; name: null | string; }, UserNotFoundError>>

Parameters

Parameter	Type
dbKey	symbol
id	number

Returns

Promise<ReturnsError<{ createdAt: Date; email: string; emailVerified: null | boolean; familyName: null | string; givenName: null | string; id: number; lastLoginAt: null | Date; name: null | string; }, UserNotFoundError>>

updateLastLogin()

updateLastLogin: (dbKey, id) => Promise<ReturnsError<{ createdAt: Date; email: string; emailVerified: null | boolean; familyName: null | string; givenName: null | string; id: number; lastLoginAt: null | Date; name: null | string; }, UserNotFoundError>>

Parameters

Parameter	Type
dbKey	symbol
id	number

Returns

Promise<ReturnsError<{ createdAt: Date; email: string; emailVerified: null | boolean; familyName: null | string; givenName: null | string; id: number; lastLoginAt: null | Date; name: null | string; }, UserNotFoundError>>

updateProfile()

updateProfile: (dbKey, userId, params) => Promise<ReturnsError<{ createdAt: Date; email: string; emailVerified: null | boolean; familyName: null | string; givenName: null | string; id: number; lastLoginAt: null | Date; name: null | string; }, UserNotFoundError>>

Parameters

Parameter	Type
dbKey	symbol
userId	number
params	UpdateProfileParams

Returns

Promise<ReturnsError<{ createdAt: Date; email: string; emailVerified: null | boolean; familyName: null | string; givenName: null | string; id: number; lastLoginAt: null | Date; name: null | string; }, UserNotFoundError>>