auth-now v2.2.2

Auth-Now

The world easiest authentication package

Installation

This is a Node.js module available through the npm registry.

Before installing, download and install Node.js. Node.js 0.10 or higher is required.

If this is a brand new project, make sure to create a package.json first with the npm init command.

Installation is done using the npm install command:

$ npm i auth-now

Features

• backend authentication just 3 stapes
• Custom create user(email and password)
• Custom login
• Login with Google
• Login with Facebook
• Admin check
• Get user info

• Logout functionality

• Dynamic Access Control Authentication(from v2)

Note: mongoose cors is required for using auth-now.

Crate a user mode

User.js(mongoose model)

const {Schema,model} = require('mongoose');

const userSchema = new Schema({
    name:{
        type: 'string',
        // require:[true,'Please Enter your Name '],
        trim:true
    },
    email: {
        type: 'string',
        require:[true,'Please Enter your Email '],
        trim: true
    },
    password: {
        type: 'string',
    },
    role:{
        type: Number,
        default:0  // user:0,admin:1
    },
    avatar: {
        type: String,
        default: "" //you can add a default image
    },
    googleID:String,
    facebookID:String,
    provider:{
        type:String,
        default:'custom',
        enum : ["custom", "google", "facebook"]
    },
    permissions:[{ //if you  need to dynamically add permissions 
        type: String
    }]

},{
    timeStamp: true
})

module.exports = model('User',userSchema);

Backend Configuration

npm i mongoose  // must install it

const app = require('express')();
const Auth = require('auth-now');

const auth = new Auth({
    model:require('./models/user'),//add your model file location
    googleClientID:process.env.GOOGLE_CLIENT_ID,
    googleClientSecret:process.env.GOOGLE_CLIENT_SECRET,
    facebookAppID:process.env.FACEBOOK_APP_ID,
    facebookAppSecret:process.env.FACEBOOK_APP_SECRET ,
    // accessTokenSecret,
    // refreshTokenSecret,
    expiresIn : {
        refreshToken:'7d',
        accessToken:'15m' //you can add it ('1s' or '1m' or '1h' or ' 1d )
    }
})

app.use('/user',auth.router(app)); // This route name must be '/user'

//connect your database

app.listen(3000,()=>{
    console.log(`server is running on port : 3000);
});

Middleware

const {authUser,authAdmin,accessPermission} = auth

authUser

This middleware used to verify authenticated users.

authAdmin

This middleware used to verify the admin.(RBAC)

accessPermission

This middleware used to dynamic access control if permitted by admin.( Using 'userPermissionUpdate()' this function admin can update user access permissions form frontend.)

Frontend

Again install the package in frontend

Note: again install the package in frontend.

configuration

import Auth from 'auth-now/client'

const auth = new Auth({ clientUrl:'http://exampole.com' })

export default auth;

### All function:
1.userRegistration({email,password,...})
2.loginWithEmailPassword(email,password)
3.userInfo()
4.loginWithGoogle(response)
5.loginWithFacebook(response)
6.logout()
7.userPermissionUpdate([..permissions])

### some veritable for frontend:
1.`clientUrl`
2.`token`
3.`user`
### 1.userRegistration({email,password,...})
This function for user create or registration .
```js
  const registerUser = async()=>{
        try {
          let res = await auth.userRegistration({email,password}) //and you can add more fields by  this object pattern  just one remark those fields are also have to user model  
        console.log(res);
        } catch (err) {
          console.log(err.response.data);
          
        }
    }

Note: you can add more fields by this object pattern just one remark those fields are also have to user model

    let res = await auth.userRegistration({email,password,firstName, lastName ,....ip,.. })

2.loginWithEmailPassword(email,password)

 const customLogin = async()=>{
      try {
        let res = await auth.loginWithEmailPassword(email,password)
        console.log(res);
      } catch (err) {
        console.log(err.response.data);
        }
    }

3.userInfo()

 const getUserData = async()=>{
      try {
        let res = await auth.userInfo();
        console.log('user',res);
        console.log('all',auth);
      } catch (err) {
        console.log(err.response.data);
        }
    }

4.loginWithGoogle(response)

const responseGoogle = async(response)=>{
      try {
        let res = await auth.loginWithGoogle(response)
        console.log(res);
        
      } catch (error) {
        console.log(error.response.data);
      }
    }

5.loginWithFacebook(response)

const responseFacebook = async(response)=>{
      try {
        let res = await auth.loginWithFacebook(response)
        console.log(res);
        
      } catch (error) {
        console.log(error.response.data);
      }
     

6.logout()

const logout =async ()=>{
   auth.logout();
}

7.userPermissionUpdate(...permissions)

note: If you add 'update-user-permissions' this to permissions user can permitted to access control like admin

const userPermissionUpdate = async()=>{
      try {
        const res = await auth.userPermissionUpdate(['update-user-permissions','add-product','edit-product'])
        console.log(res);

  } catch (error) {
    console.log(error.response.data);
  }

}