roler.js

JavaScript rol based permission

Define Roles

// role.ts

export enum Role {
  OWNER = 'OWNER',
  ADMIN = 'ADMIN',
  USER = 'USER',
}

Define Paths

export enum Path {
  // localhost:3000/
  HOME,

  // localhost:3000/overview
  OVERVIEW,

  // localhost:3000/overview/1
  OVERVIEW_ID,
}

Define Paths Regex

import { Path } from "./path";

export const PathRe = {
  // will match '/'
  [Path.HOME]: /^[\/]$/,

  // will match '/overview'
  [Path.OVERVIEW]: /^\/overview((?:\/)+)?$/,

  // will match /overview/1, /overview/asd ...
  [Path.OVERVIEW_ID]: /^\/overview(\/[a-zA-Z0-9]+)$/,
};

Define Permissions

import { Role } from "./role";
import { Path } from "./path";

export const permissions = {
  // home
  [Path.HOME]: {
    canNotSee: [], // all roles can see / page
    canNotAction: {
      __btn_owner: [Role.ADMIN, Role.USER], // ADMIN and USER can not action on __btn_owner
      __text_owner: [Role.ADMIN, Role.USER],
      __btn_admin: [Role.USER],
      __text_admin: [Role.USER], // USER can not action on __text_admin
      __btn_user: [],
      __text_user: [],
    },
  },
  // overview
  [Path.OVERVIEW]: {
    canNotSee: [Role.USER], // USER can not see /overview
    canNotAction: {
      __btn_click: [Role.ADMIN],
    },
  },
  // overview/<id>
  [Path.OVERVIEW_ID]: {
    canNotSee: [Role.USER, Role.ADMIN], // USER and ADMIN can not see /overview/<id>
    canNotAction: {
      __btn_click: [],
    },
  },
};

Example Usage

// ssr
export async function requireUserSession(request: Request) {
  ...

  // get role of current user
  const role = session.role;

  // get role based permission for <url>
  const { canNotSee, canNotAction } = getPermission(role, request.url);

  // if the user can not see the url, then redirect
  if (canNotSee) {
    // redirect
  }

  return { session, permission: canNotAction };
}


// overview.tsx
export default function Overview() {
  ...
  const { ..., permission } = useLoaderData();

  return (
    ...
      {permission.__btn_click && <button>can click?</button>}
    ...
  );

}

LICENSE

MIT License

Copyright (c) 2023 Sergen Çepoğlu

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.