TGW Auth

Note:

If you do not use in react project, you do not need to do any command related to axios

Installation

npm i tgw-auth --registry https://npm.thegioiwhey.com

# if you get error related axios (almost happen in react projects), run this command
npm i [email protected]

Init class

import Auth from "tgw-auth";

const auth = new Auth("url-for-auth");

// if you get error related axios (almost happen in react projects), import axios and add axios in Auth class as second parameter
import axios from "axios";

const auth = new Auth("url-for-auth", axios);

Login

You can add functions to the options parameter or check data returned to handle after login.

// view below Login Result Data for more details
const data = await auth.login(
  // data for login including username and password
  loginData,

  // not required
  // optional options for handling data after login
  // view below Login Options for more details
  options
);

Login Options

| Props | Type | Description | | ------------------ | -------- | --------------------------------------------------- | | onSuccess | function | A function executed when login success | | onWrongCredentials | function | A function executed when wrong username or password | | onBadRequest | function | A function executed when wrong validate login data | | onError | function | A function executed when other errors |

Login Result Data

| Props | Type | Value / Description | | ------ | -------------- | ------------------------------------------------------------------- | | status | string | "success" or "bad_request" or "wrong_credentials" or "server_error" | | data | object | Data returned from login, including access token, user data | | code | number or null | Error code |

Check permission

You can add functions to the options parameter or check data returned to handle after sending request.

// view below Check Permission Result Data for more details
const data = await auth.checkPermission(
  // data for check permission, more details at Check Permission Data
  permissionData,

  // access token after login
  accessToken

  // not required
  // optional options for handling data after sending request
  // view below Check Permission Options for more details
  options
);

Check Permission Data

| Props | Type | Description | | ------------ | -------------- | ------------------------------------------------------------ | | resourceCode | string | required resource code | | actionCodes | string[] | array of required action codes | | type | "one" or "all" | if you only need one of required actions, "one", else "all". |

Check Permission Options

| Props | Type | Description | | -------------- | -------- | ------------------------------------------------------ | | onSuccess | function | A function executed when success | | onUnauthorized | function | A function executed when unauthorized | | onBadRequest | function | A function executed when wrong validate permissionData | | onError | function | A function executed when other errors |

Check Permission Result Data

| Props | Type | Value / Description | | ------ | -------------- | -------------------------------------------------------------- | | status | string | "success" or "bad_request" or "unauthorized" or "server_error" | | data | object | Data returned from sending request | | code | number or null | Error code |

Get Roles

You can add functions to the options parameter or check data returned to handle after sending request.

// view below Get Roles Result Data for more details
const data = await auth.getRoles(
  // access token after login
  accessToken

  // not required
  // optional options for handling data after sending request
  // view below Get Roles Options for more details
  options
);

Get Roles Options

| Props | Type | Description | | -------------- | -------- | ------------------------------------- | | onSuccess | function | A function executed when success | | onUnauthorized | function | A function executed when unauthorized | | onError | function | A function executed when other errors |

Get Roles Result Data

| Props | Type | Value / Description | | ------ | -------------- | --------------------------------------------------- | | status | string | "success" or "unauthorized" or "server_error" | | data | object | Data returned from sending check-permission request | | code | number or null | Error code |

Get Profile

You can add functions to the options parameter or check data returned to handle after sending request.

// view below Get Profile Result Data for more details
const data = await auth.getProfile(
  // access token after login
  accessToken

  // not required
  // optional options for handling data after sending request
  // view below Get Profile Options for more details
  options
);

Get Profile Options

| Props | Type | Description | | -------------- | -------- | ------------------------------------- | | onSuccess | function | A function executed when success | | onUnauthorized | function | A function executed when unauthorized | | onError | function | A function executed when other errors |

Get Profile Result Data

| Props | Type | Value / Description | | ------ | -------------- | --------------------------------------------------- | | status | string | "success" or "unauthorized" or "server_error" | | data | object | Data returned from sending check-permission request | | code | number or null | Error code |