@mertsolak/permission-manager-react v1.0.0

Permission Manager React

Developed for permission management using hexadecimal numbers with typescript and react support

Installation

Use node package manager to install @mertsolak/permission-manager-react.

npm i @mertsolak/permission-manager-react

Basic Usage

// index.tsx
import React from "react";
import ReactDOM from "react-dom";

import { PermissionProvider, createPermissionNames } from "@mertsolak/permission-manager-react";

import App from "./App";

// it is important to use this method for typescript support
// permission names should match with backend's permission names
const permissionNames = createPermissionNames('login', 'logout');

 // this type can be used to provide typescript support for usePermission hook
export type PermissionNamesType = typeof permissionNames[number];

// initial permission number can be updated at any time
ReactDOM.render(
    <PermissionProvider permissionNames={permissionNames} initialPermissionNumber='0x0'>
      <App />
    </PermissionProvider>
  document.getElementById("root")

// App.tsx
import React from 'react';
import { BrowserRouter, Switch } from 'react-router-dom';

import { AuthorizedRoute } from '@mertsolak/permission-manager-react';

const LoginComponent = () => <p>login page</p>;

export const App = () => (
  <BrowserRouter>
    <Switch>
      <AuthorizedRoute
        component={LoginComponent}
        path="/"
        redirectPath="/login" // this is needed for redirection
        isAuthenticated // it is optional, if it is false, it ignores allowedPermissions
        allowedPermissions={['login']} // it is optional, it uses operator parameter for permissions
        operator="&" // allowedPermissions uses this for authorization, default = '|', it is optional
      />
    </Switch>
  </BrowserRouter>
);

// AnyComponent.tsx

import React from 'react';

import { usePermissions } from '@mertsolak/permission-manager-react';

import { PermissionNamesType } from './index';

export const AnyComponent = () => {
  const { addPermissions, removePermissions, verifyPermissions, permissionNumber, permissionObject } =
    usePermissions<PermissionNamesType>(); // type is needed for better typescript support

  useEffect(() => {
    // adds permissions globally to permissionNumber
    addPermissions(['home', 'profile']);
    // removes permissions globally from permissionNumber
    removePermissions(['login']);
    // it verifies that permissionNumber includes these permissions with operator &
    const hasPermission = verifyPermissions(['home', 'profile', 'login', 'logout'], '&');

    // global permissionNumber
    console.log(permissionNumber);
    // global permissionObject
    console.log(permissionObject);
  }, []);

  return <p>Any Component</p>;
};