{"id":13487596,"url":"https://github.com/lidianhao123/egg-rbac","last_synced_at":"2025-05-01T11:30:49.753Z","repository":{"id":57220701,"uuid":"109798654","full_name":"lidianhao123/egg-rbac","owner":"lidianhao123","description":"Role Based Access Control for eggjs","archived":false,"fork":false,"pushed_at":"2018-09-25T09:44:27.000Z","size":386,"stargazers_count":31,"open_issues_count":0,"forks_count":4,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-10-30T22:40:13.632Z","etag":null,"topics":["egg","egg-plugin","eggjs","rbac"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/lidianhao123.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-11-07T07:00:41.000Z","updated_at":"2024-09-08T01:26:33.000Z","dependencies_parsed_at":"2022-08-28T23:23:52.696Z","dependency_job_id":null,"html_url":"https://github.com/lidianhao123/egg-rbac","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lidianhao123%2Fegg-rbac","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lidianhao123%2Fegg-rbac/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lidianhao123%2Fegg-rbac/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lidianhao123%2Fegg-rbac/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lidianhao123","download_url":"https://codeload.github.com/lidianhao123/egg-rbac/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224253344,"owners_count":17280934,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["egg","egg-plugin","eggjs","rbac"],"created_at":"2024-07-31T18:01:01.016Z","updated_at":"2024-11-12T10:12:59.988Z","avatar_url":"https://github.com/lidianhao123.png","language":"JavaScript","funding_links":[],"categories":["Plugins","仓库"],"sub_categories":["插件"],"readme":"# egg-rbac\n\n[![NPM version][npm-image]][npm-url]\n[![build status][travis-image]][travis-url]\n[![Test coverage][codecov-image]][codecov-url]\n[![David deps][david-image]][david-url]\n[![Known Vulnerabilities][snyk-image]][snyk-url]\n[![npm download][download-image]][download-url]\n\n[npm-image]: https://img.shields.io/npm/v/egg-rbac.svg?style=flat-square\n[npm-url]: https://npmjs.org/package/egg-rbac\n[travis-image]: https://img.shields.io/travis/lidianhao123/egg-rbac.svg?style=flat-square\n[travis-url]: https://travis-ci.org/lidianhao123/egg-rbac\n[codecov-image]: https://img.shields.io/codecov/c/github/lidianhao123/egg-rbac.svg?style=flat-square\n[codecov-url]: https://codecov.io/github/lidianhao123/egg-rbac?branch=master\n[david-image]: https://img.shields.io/david/lidianhao123/egg-rbac.svg?style=flat-square\n[david-url]: https://david-dm.org/lidianhao123/egg-rbac\n[snyk-image]: https://snyk.io/test/npm/egg-rbac/badge.svg?style=flat-square\n[snyk-url]: https://snyk.io/test/npm/egg-rbac\n[download-image]: https://img.shields.io/npm/dm/egg-rbac.svg?style=flat-square\n[download-url]: https://npmjs.org/package/egg-rbac\n\n\u003c!--\nDescription here.\n--\u003e\n## [中文说明](./README.zh_CN.md)\n\n## Install\n\n```bash\n$ npm i egg-rbac --save\n```\n\n## depend on egg version\n\negg-rbac version | egg version\n--- | ---\n0.3.0 | 1.x\n0.4.0 | 2.0.0\n\nFrom 0.4.0 version egg-rbac does not support egg 1.x.\n\n## depend on egg plugin\n\n- [egg-mongoose](https://github.com/eggjs/egg-mongoose)\n\n## Usage\n\n```js\n// {app_root}/config/plugin.js\nexports.rbac = {\n  enable: true,\n  package: 'egg-rbac',\n};\n```\n\n## Configuration\n\nconfig getRoleName\n```js\n// {app_root}/config/config.default.js\nexports.rbac = {\n  /**\n   * @param {object} ctx - egg context object\n   * @return {object} promise, if resolve data is falsy, no role\n   */\n  * getRoleName(ctx) {\n    return Promise.resolve('');\n  },\n};\n```\n\nInitialize roles and permissions\n```js\n// {app_root/config/rbac.js}\n'use strict';\n\nexports.permissions = [\n  // action_resource\n  // { name: 'create_user', alias: '创建用户' },\n  // { name: 'delete_user', alias: '删除用户' },\n  // { name: 'query_user', alias: '查询用户' },\n  // { name: 'edit_user', alias: '修改用户' },\n];\n\nexports.roles = [\n  // { name: 'admin', alias: '管理员', grants: exports.permissions.map(item =\u003e item.name) },\n];\n```\n\nsee [config/config.unittest.js](./test/fixtures/apps/rbac-test/config/config.unittest.js) for more detail.\n\n## Example\n\n1. see [rbac-test](./test/fixtures/apps/rbac-test/)\n2. practical example [egg-rbac-example](https://github.com/lidianhao123/egg-rbac-example)\n\n## Remarks\n\n- It will create a superadmin role which own all permissions.\n\n## License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flidianhao123%2Fegg-rbac","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flidianhao123%2Fegg-rbac","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flidianhao123%2Fegg-rbac/lists"}