@peterkapena/user_auth v1.0.0-beta.13

UserService

Summary

The UserService class provides methods for user authentication and management. It uses the User model and external libraries like bcrypt for password hashing and jwt for token encoding and decoding.

Example Usage

const userService = new UserService(userModel, DuplicateCheck.BOTH_USERNAME_EMAIL);

// Sign in with username and password
const user = await userService.simple_signIn("john_doe", "password");
// Output: User object

// Sign in with email and password
const user = await userService.simple_signIn("john@example.com", "password");
// Output: User object

// Sign up a new user
const newUser: User = {
  email: "jane@example.com",
  username: "jane_doe",
  password: "password",
  roles: ["user"],
};
const success = await userService.signUp(newUser);
// Output: true if the user is successfully created, false if there is a duplicate email or username

// Verify a token
const token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...";
const result = await userService.verifyToken(token, publicKey, secretKeyHex, ivHex);
// Output: { isValid: true, token: "...", email: "...", username: "...", roles: [...] } if the token is valid, { isValid: false } otherwise

Code Analysis

Main functionalities

• User sign-in and sign-up
• Token encoding and decoding
• Token verification

Methods

• constructor(userModel: any, duplicateCheck: DuplicateCheck): Initializes the UserService with a user model and a duplicate check option.
• async simple_signIn(username: string, password: string): Promise<User>: Performs a simple sign-in by username or email and password. Returns the user object if the credentials are correct.
• async signIn(username: string, password: string, prtKey: string, secretKeyHex: string, ivHex: string): Promise<SignInReturn>: Performs a sign-in by username and password, and encodes a JWT token. Returns a SignInReturn object with the token, email, username, and roles.
• async verifyToken(inputToken: string, pubKey: string, secretKeyHex: string, ivHex: string): Promise<SignInReturn & { isValid: boolean }>: Verifies a JWT token and returns a SignInReturn object with additional isValid field indicating if the token is valid.
• async signUp(user: User): Promise<boolean>: Signs up a new user by creating a user object and checking for duplicates. Returns true if the user is successfully created, false otherwise.
• private async isDuplicate(user: User): Promise<boolean>: Checks if a user object has duplicate email or username based on the duplicate check option.

Fields

• userModel: any: The user model used for database operations.
• duplicateCheck: DuplicateCheck: The option for duplicate check, can be DuplicateCheck.EMAIL, DuplicateCheck.USERNAME, or DuplicateCheck.BOTH_USERNAME_EMAIL.