MAXI VALIDATE PERMISSIONS

This library provides utilities to manage and validate user permissions using JSON Web Tokens (JWT). The library includes functionalities to decode JWT, check token validity, and fetch user permissions.

Table of Contents

• Installing
• Explanation
• Examples
• Response

Installing

To use this library, you need to have maxi-validate-permissions-test installed. You can install this dependency:

Using npm:

1$ npm install maxi-validate-permissions-test

Using bower:

1$ bower install maxi-validate-permissions-test

Using yarn:

1$ yarn add maxi-validate-permissions-test

Using pnpm:

1$ pnpm add maxi-validate-permissions-test

Explanation

This code is a TypeScript module that includes functions for handling user permissions and validating them based on a token received from an API. Here is a step-by-step explanation of the code:

1. The code imports necessary modules such as axios for making HTTP requests, jwt-decode for decoding JWT tokens, and luxon for date and time manipulation.

2. It defines various interfaces and enums for handling token decoding, response data, user roles, systems, modules, permissions, and permission information.

3. It sets a URL for an API endpoint that checks user permissions.

4. The callApi function is defined to make a GET request to the API endpoint with a provided token. It returns a response containing the status, message, and user role data.

5. The decodeToken function decodes a JWT token and returns the decoded token along with a status and message.

6. The isTokenActive function checks if a token is valid and active by decoding the token and checking its expiration time against the current time.

7. The getPermissionsUnique function retrieves unique permissions for a specific system and permission name from a user role.

8. The getPermissionsInGroup function retrieves permissions for a group of systems and permission names from a user role.

9. The validatePermission function validates a single permission based on the provided token, permission system, and permission name by calling isTokenActive , callApi , and getPermissionsUnique functions.

10. The validateGroupPermissions function validates a group of permissions for a system based on the provided token, system name, and array of permissions by calling isTokenActive , callApi , and getPermissionsInGroup functions.

In summary, this code module provides functions to handle user permissions, decode tokens, check token validity, and validate permissions based on the user's role and provided token.

Examples

Validate Permission

1import { validatePermission } from 'maxi-validate-permissions-test';
2//const { validatePermission } = require('maxi-validate-permissions-test'); // legacy way
3
4const token = "*****";
5const permissionSystem = "test";
6const permissionName = "TEST_USER_MANGEMENT_PERM_1000";
7
8validatePermission(
9  token,
10  permissionSystem,
11  permissionName,
12 ).then((data) => console.log(data));

Validate Group Permissions

1import { validateGroupPermissions } from 'maxi-validate-permissions-test';
2//const { validateGroupPermissions } = require('maxi-validate-permissions-test'); // legacy way
3
4const token = "*****";
5const systemName = "test";
6
7const permissions = [
8  "TEST_USER_MANAGMENT_PERM_2",
9  "TEST_USER_MANAGMENT_PERM_1",
10  "TEST_USER_MANAGMENT_PERM_10",
11  "TEST_USER_MANAGMENT_PERM_3",
12];
13
14validateGroupPermissions(token, systemName, permissions).then((data) =>
15  console.log(data)
16);

Response

When request failed.

1{ status: 'error', message: 'Request failed.' }

When token is invalid.

1{ status: 'error', message: 'The token is invalid.' }

When token is expired.

1{ status: 'error', message: 'The token has expired.' }

When permission system doesn´t exist.

1{ status: 'success', message: 'Request successful.', permission: null }

Validate Permission

When permission doesn´t exist.

1{
2    status: 'success',
3    message: 'Request successful.',
4    permission: { TEST_USER_MANGEMENT_PERM_1000: null }
5}

When the user has access to the permission.

1{
2    status: 'success',
3    message: 'Request successful.',
4    permission: { TEST_USER_MANAGMENT_PERM_2: { view: true, edit: false } }
5}

Validate Group Permissions

List of permissions that the user has access to use.

1{
2    status: 'success',
3    message: 'Request successful.',
4    permission: [
5      { TEST_USER_MANAGMENT_PERM_2: {"view":true,"edit":false} },
6      { TEST_USER_MANAGMENT_PERM_1: null },
7      { TEST_USER_MANAGMENT_PERM_10: null },
8      { TEST_USER_MANAGMENT_PERM_3: {"view":true,"edit":false} }
9    ]
10}