Staff TGW

Installation

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

Usage

Import

import Staff from "staff-tgw";

Init class

const staff = new Staff("url-for-auth");

Login

type User = {
  id: number,
  firstName: string,
  lastName: string,
  avatar: string,
  positionName: string,
};

type LoginResponse = {
  accessToken: string,
  user: User,
};

// Solution 1:
staff.login({
  body: {
    username: "your-username",
    password: "your-password",
  },
  onSuccess(data) {
    // do something when success
  },
  onWrongCredentials() {
    //do something when wrong password or username
  },
  onError(error) {
    // do something when other errors
  },
});

// Solution 2:

const { code, data } = await staff.login({
  body: {
    username: "your-username",
    password: "your-password",
  },
});

code = 0; // login success
code = 409; // wrong username or password

| Props | is required | Description | | ------------------ | ----------- | ------------------------------------------------------ | | body | true | Body of login request, including username and password | | onSuccess | false | A function executed when login success | | onWrongCredentials | false | A function executed when wrong username or password | | onError | false | A function executed when other errors |

Check permission

type CheckPermissionBody = {
  resourceCode: string,
  actionCodes: string[],
  type: "one" | "all",
};

type CheckPermissionResponse = {
  hasPermission: boolean,
  userId: number,
};

staff.checkPermission({
  accessToken: "your-access-token",
  body: {
    resourceCode: "your-resource-code",
    type: "all",
    actionCodes: ["action-code-1", "action-code-2"],
  },
  onSuccess(data: CheckPermissionResponse) {},
  onUnauthorized() {},
  onError(error) {},
});

| Props | is required | Description | | -------------- | ----------- | ------------------------------------------- | | accessToken | true | Access token | | body | true | Body of check permission request | | onSuccess | false | A function executed when login success | | onUnauthorized | false | A function executed when wrong access token | | onError | false | A function executed when other errors |

Get roles

type AuthRoleResponse = {
  roleActions: {
    resourceCode: string,
    actions: {
      code: string,
      label: string,
      isAllowed: boolean,
    }[],
  }[],
  userId: number,
};

staff.getRoles({
  accessToken: "your-access-token",
  onSuccess(data: AuthRoleResponse) {},
  onUnauthorized() {},
  onError(error) {},
});

| Props | is required | Description | | -------------- | ----------- | ------------------------------------------- | | accessToken | true | Access token | | onSuccess | false | A function executed when success | | onUnauthorized | false | A function executed when wrong access token | | onError | false | A function executed when other errors |