{"id":15894711,"url":"https://github.com/clayrisser/role-based-access-control","last_synced_at":"2026-01-20T13:02:07.866Z","repository":{"id":65491171,"uuid":"158988510","full_name":"clayrisser/role-based-access-control","owner":"clayrisser","description":"unopinionated role based access control","archived":false,"fork":false,"pushed_at":"2023-07-13T05:26:08.000Z","size":524,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-10-05T06:09:45.410Z","etag":null,"topics":["access-control","node","nodejs","rbac","rbac-management","role-based-access-control"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/clayrisser.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-11-25T01:43:05.000Z","updated_at":"2023-07-13T05:17:03.000Z","dependencies_parsed_at":"2024-10-06T08:41:23.418Z","dependency_job_id":"4caa36fe-2a3f-4266-9fb1-59a147972ed8","html_url":"https://github.com/clayrisser/role-based-access-control","commit_stats":null,"previous_names":["codejamninja/role-based-access-control"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/clayrisser/role-based-access-control","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clayrisser%2Frole-based-access-control","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clayrisser%2Frole-based-access-control/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clayrisser%2Frole-based-access-control/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clayrisser%2Frole-based-access-control/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/clayrisser","download_url":"https://codeload.github.com/clayrisser/role-based-access-control/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clayrisser%2Frole-based-access-control/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28603404,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T12:01:53.233Z","status":"ssl_error","status_checked_at":"2026-01-20T12:01:46.545Z","response_time":117,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["access-control","node","nodejs","rbac","rbac-management","role-based-access-control"],"created_at":"2024-10-06T08:41:15.497Z","updated_at":"2026-01-20T13:02:07.842Z","avatar_url":"https://github.com/clayrisser.png","language":"TypeScript","funding_links":["https://liberapay.com/codejamninja/donate"],"categories":[],"sub_categories":[],"readme":"# role-based-access-control\n\n[![npm](https://img.shields.io/npm/dt/role-based-access-control.svg?style=flat-square)](https://www.npmjs.com/package/role-based-access-control)\n[![GitHub](https://img.shields.io/github/license/codejamninja/role-based-access-control.svg?style=flat-square)](https://www.npmjs.com/package/role-based-access-control)\n[![npm type definitions](https://img.shields.io/npm/types/role-based-access-control.svg?style=flat-square)](https://www.npmjs.com/package/role-based-access-control)\n[![GitHub stars](https://img.shields.io/github/stars/codejamninja/role-based-access-control.svg?label=Stars\u0026style=flat-square)](https://github.com/codejamninja/role-based-access-control)\n\n\n\u003e unopinionated role based access control\n\n![](assets/role-based-access-control.png)\n\nPlease ★ this repo if you found it useful ★ ★ ★\n\n\n## Features\n\n* unopinionated\n* supports multiple roles\n* supports custom policies\n\n\n## Installation\n\n```sh\nnpm install --save role-based-access-control\n```\n\n\n## Dependencies\n\n* [NodeJS](https://nodejs.org)\n\n\n## Usage\n\nImport `role-based-access-control`\n```js\nimport { Policy, Role, Statement, Subject } from 'role-based-access-control';\n```\n\nCreate statements\n```js\nconst statements = {\n  readFile: new Statement('read', 'file'),\n  readFolder: new Statement('read', 'folder'),\n  removeFile: new Statement('remove', 'file'),\n  removeFolder: new Statement('remove', 'folder'),\n  writeFile: new Statement('write', 'file'),\n  writeFolder: new Statement('write', 'folder')\n};\n```\n\nCreate policies from statements\n```js\nconst policies = {\n  readFile: new Policy('readFile', [statements.readFile]),\n  readFolder: new Policy('readFolder', [statements.readFolder]),\n  removeFile: new Policy('removeFile', [statements.removeFile]),\n  removeFolder: new Policy('removeFolder', [statements.removeFolder]),\n  writeFile: new Policy('readFile', [statements.writeFile]),\n  writeFolder: new Policy('readFolder', [statements.writeFolder]),\n  readAll: new Policy('readAll', [statements.readFile, statements.readFolder]),\n  removeAll: new Policy('removeAll', [\n    statements.removeFile,\n    statements.removeFolder\n  ]),\n  writeAll: new Policy('readAll', [\n    statements.writeFile,\n    statements.writeFolder\n  ]),\n  allFiles: new Policy('allFiles', [\n    statements.readFile,\n    statements.writeFile,\n    statements.removeFile\n  ]),\n  allFolders: new Policy('allFolders', [\n    statements.readFolder,\n    statements.writeFolder,\n    statements.removeFolder\n  ])\n};\n```\n\nCreate roles from policies\n```js\nconst roles = {\n  visitor: new Role('visitor', [policies.readAll]),\n  user: new Role('user', [policies.readAll, policies.writeAll]),\n  admin: new Role('admin', [policies.allFiles, policies.allFolders])\n};\n```\n\nAssign roles to subjects\n\n```js\nconst someVisitor = new Subject('someVisitor', [roles.visitor]);\nconst someAdmin = new Subject('someVisitor', [roles.admin]);\n```\n\nCheck if subject can execute statement\n```js\nsomeVisitor.can(statements.readFile); // true\nsomeVisitor.can(statements.deleteFile); // false\n\nsomeAdmin.can(statements.readFile); // true\nsomeAdmin.can(statements.deleteFile); // true\n```\n\n\n## Support\n\nSubmit an [issue](https://github.com/codejamninja/role-based-access-control/issues/new)\n\n\n## Roadmap\n\n* Support role inheritance\n* Support blocking statements\n* Support resource ownership\n* Support role tagging\n\n\n## Contributing\n\nReview the [guidelines for contributing](https://github.com/codejamninja/role-based-access-control/blob/master/CONTRIBUTING.md)\n\n\n## License\n\n[MIT License](https://github.com/codejamninja/role-based-access-control/blob/master/LICENSE)\n\n[Jam Risser](https://codejam.ninja) © 2018\n\n\n## Changelog\n\nReview the [changelog](https://github.com/codejamninja/role-based-access-control/blob/master/CHANGELOG.md)\n\n\n## Credits\n\n* [Jam Risser](https://codejam.ninja) - Author\n\n\n## Support on Liberapay\n\nA ridiculous amount of coffee ☕ ☕ ☕ was consumed in the process of building this project.\n\n[Add some fuel](https://liberapay.com/codejamninja/donate) if you'd like to keep me going!\n\n[![Liberapay receiving](https://img.shields.io/liberapay/receives/codejamninja.svg?style=flat-square)](https://liberapay.com/codejamninja/donate)\n[![Liberapay patrons](https://img.shields.io/liberapay/patrons/codejamninja.svg?style=flat-square)](https://liberapay.com/codejamninja/donate)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclayrisser%2Frole-based-access-control","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclayrisser%2Frole-based-access-control","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclayrisser%2Frole-based-access-control/lists"}