@codestra/authentication-manager

authentication-manager is a package that provides helper functions for user management.

Installation

Use npm for installation:

npm install @codestra/authentication-manager

Or use yarn for installation:

yarn add @codestra/authentication-manager

Usage

You need to have a running mongoose connection.

Example

The following is a full example of all the functions and how you can use them.

// The model needs to at least have these fields
const UserSchema = new mongoose.Schema({
  email: { type: String, required: true, unique: true },
  password: { type: String, required: true },
  salt: { type: String },
  passwordResetToken: { type: String },
  passwordResetExpires: { type: Number },
  activated: { type: Boolean },
  activationToken: { type: String },
});
const User = mongoose.model('User', UserSchema);

// creates a new user and returns the modelSignUpData._id and modelSignUpData.activationToken
const modelSignUpData = await modelSignUp({
  Model: User,
  variables: { email: 'foo@bar.io', password: 'verymuchsecure' },
});

// activates the user with the activation token and returns a authentication token
const authenticationTokenActivate = await modelActivate({
  Model: User,
  variables: { activationToken: modelSignUpData.activationToken },
});

// returns the authentication modelSignInData.token and modelSignInData._id if the password was right
const modelSignInData = await modelSignIn({
  Model: User,
  variables: { email: 'foo@bar.io', password: 'verymuchsecure' },
});

// verifies the authentication token
const authentication1 = modelVerify({ token: authenticationTokenActivate });
// or
const authentication2 = modelVerify({ token: modelSignInData.token });

// returns a password reset token that we need to give the user to reset
const passwordResetToken = await modelRequestResetPassword({
  Model: User,
  variables: { email: 'foo@bar.io' },
});

// verifies that the password reset token was right and sets the new password
const email = await modelRequestUpdatePassword({
  Model: Vendor,
  variables: { passwordResetToken, email: 'foo@bar.io', password: 'newverysecure' },
});

Functions

genRandomString(length): generates random string of characters i.e salt
createHash(password, salt): hash password with sha512.
modelActivate(parameters) ⇒ Promise.<string>: Activates the model with the activationToken and returns the jwt.
modelRequestResetPassword(parameters) ⇒ Promise.<string>: Will update the reset token and send an email. If the user was found, will return passwordResetToken
modelRequestUpdatePassword(parameters) ⇒ Promise.<string>: Will update the reset token and send an email. If the user was found, will return the mail
modelResendActivation(parameters) ⇒ Promise.<string>: Request the activation token.
modelSignIn(parameters) ⇒ Promise.<string>: Signs in the model and sends back the jwt if the account is activated. Will also make the email lowercase before trying to find the document.
modelSignUp(parameters) ⇒ Promise.<{activationToken: string, _id: string}>: Creates a new document based on the supplied model the email, password and other fields. Will return the new _id and the activationtoken
modelVerify(parameters) ⇒ JwtPayload | null: Verifies the token

genRandomString(length)

generates random string of characters i.e salt

Param	Type	Description
length	`number`	Length of the random string.

createHash(password, salt)

hash password with sha512.

Param	Type	Description
password	`string`	List of required fields.
salt	`string`	Data to be validated.