diff --git a/.changeset/five-chicken-sleep.md b/.changeset/five-chicken-sleep.md deleted file mode 100644 index 3f00c2f..0000000 --- a/.changeset/five-chicken-sleep.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@sellerartifact/accesscontrol': patch ---- - -chore: rm unuse code & replace alias path diff --git a/CHANGELOG.md b/CHANGELOG.md index fc36e43..561ea7f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ ## AccessControl - Change Log +## 2.3.5 + +### Patch Changes + +- chore: update docs +- 3b5e61a: chore: rm unuse code & replace alias path + ## 2.3.2 ### Patch Changes diff --git a/README.md b/README.md index 9b43b1b..af655ed 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,29 @@

- AccessControl.js + AccessControl.js

- Build Status - Coverage Status - Dependencies - Known Vulnerabilities - Maintained + Coverage Status + Dependencies + Known Vulnerabilities + Maintained
npm - Release + Release Downloads/mo. - License + License TypeScript Documentation
- © 2024, Onur Yıldırım (@wangjue666). + © 2024, invalid w (@wangjue666).


+# Why this repo ? + +This repo is a fork of the original [accesscontrol](https://github.com/onury/accesscontrol), and the original repo is no longer maintained. I will try to maintain this repo and fix the issues and add new features. + +This repo was rebuilt using [modern.js](https://github.com/web-infra-dev/modern.js) + ### Role and Attribute based Access Control for Node.js Many [RBAC][rbac] (Role-Based Access Control) implementations differ, but the basics is widely adopted since it simulates real life role (job) assignments. But while data is getting more and more complex; you need to define policies on resources, subjects or even environments. This is called [ABAC][abac] (Attribute-Based Access Control). @@ -35,7 +40,7 @@ With the idea of merging the best features of the two (see this [NIST paper][nis Resources Permissions More - F.A.Q. + F.A.Q. API Reference @@ -66,7 +71,7 @@ with [**yarn**](https://yarn.pm/@sellerartifact/accesscontrol): `yarn add @selle ## Guide ```js -const AccessControl = require('@sellerartifact/accesscontrol'); +const { AccessControl } = require('@sellerartifact/accesscontrol'); // or: // import { AccessControl } from '@sellerartifact/accesscontrol'; ``` @@ -192,7 +197,7 @@ ac.grant('role').readOwn('resource'); ac.deny('role').deleteAny('resource'); ``` -_Note that **own** requires you to also check for the actual possession. See [this](https://github.com/onury/accesscontrol/issues/14#issuecomment-328316670) for more._ +_Note that **own** requires you to also check for the actual possession. See [this](https://github.com/sellerartifact/accesscontrol/issues/14#issuecomment-328316670) for more._ ## Resources and Resource-Attributes @@ -352,11 +357,12 @@ Travis build should pass, coverage should not degrade. [**MIT**][license]. -[docs]: http://onury.io/accesscontrol/?api=ac -[faq]: http://onury.io/accesscontrol/?content=faq +[docs]: https://accesscontrol-psi.vercel.app/?api=ac +[faq]: https://accesscontrol-psi.vercel.app/?content=faq [rbac]: https://en.wikipedia.org/wiki/Role-based_access_control [abac]: https://en.wikipedia.org/wiki/Attribute-Based_Access_Control [crud]: https://en.wikipedia.org/wiki/Create,_read,_update_and_delete [nist-paper]: http://csrc.nist.gov/groups/SNS/rbac/documents/kuhn-coyne-weil-10.pdf [changelog]: https://github.com/sellerartifact/accesscontrol/blob/master/CHANGELOG.md [license]: https://github.com/sellerartifact/accesscontrol/blob/master/LICENSE +[modern.js]: https://github.com/web-infra-dev/modern.js/ diff --git a/package.json b/package.json index 5b9c595..ef37194 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,7 @@ { "name": "@sellerartifact/accesscontrol", - "version": "2.3.4", + "description": "Role and Attribute based Access Control for Node.js. Create With modern.js", + "version": "2.3.5", "types": "./dist/types/index.d.ts", "main": "./dist/lib/index.js", "module": "./dist/es/index.js", @@ -9,6 +10,9 @@ "bugs": { "url": "https://github.com/sellerartifact/accesscontrol/issues" }, + "files": [ + "dist" + ], "homepage": "https://github.com/sellerartifact/accesscontrol#readme", "scripts": { "prepare": "modern build && husky install",