Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

(feat) Allow number as valid role and grant type (fixes #93) #94

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

(feat) Allow number as valid role and grant type (fixes #93) #94

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
090a338
Update TypeScript and remove unsupported node versions
vegerot Nov 20, 2020
0b40633
(feat) Allow `number` as valid role and grant type
vegerot Nov 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
language: node_js
node_js:
- '8'
- '6'
- '14'
- '12'
- '10'
before_script: cd $TRAVIS_BUILD_DIR
script:
- npm run cover
Expand Down
37 changes: 19 additions & 18 deletions lib/AccessControl.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { Access, IAccessInfo, Query, IQueryInfo, Permission } from './core';
import type { ValidRoleOrArray, ValidRole } from '.';
/**
* @classdesc
* AccessControl class that implements RBAC (Role-Based Access Control) basics
Expand Down Expand Up @@ -118,7 +119,7 @@ declare class AccessControl {
* @name AccessControl#isLocked
* @type {Boolean}
*/
readonly isLocked: boolean;
get isLocked(): boolean;
/**
* Gets the internal grants object that stores all current grants.
*
Expand Down Expand Up @@ -234,7 +235,7 @@ declare class AccessControl {
* @throws {AccessControlError} - If a role is extended by itself or a
* non-existent role. Or if called after `.lock()` is called.
*/
extendRole(roles: string | string[], extenderRoles: string | string[]): AccessControl;
extendRole(roles: ValidRoleOrArray, extenderRoles: ValidRoleOrArray): AccessControl;
/**
* Removes all the given role(s) and their granted permissions, at once.
* @chainable
Expand All @@ -246,7 +247,7 @@ declare class AccessControl {
*
* @throws {AccessControlError} - If called after `.lock()` is called.
*/
removeRoles(roles: string | string[]): AccessControl;
removeRoles(roles: ValidRoleOrArray): AccessControl;
/**
* Removes all the given resources for all roles, at once.
* Pass the `roles` argument to remove access to resources for those
Expand All @@ -263,7 +264,7 @@ declare class AccessControl {
*
* @throws {AccessControlError} - If called after `.lock()` is called.
*/
removeResources(resources: string | string[], roles?: string | string[]): AccessControl;
removeResources(resources: ValidRoleOrArray, roles?: ValidRoleOrArray): AccessControl;
/**
* Gets all the unique roles that have at least one access information.
*
Expand All @@ -284,12 +285,12 @@ declare class AccessControl {
*
* @returns {Array<String>}
*/
getInheritedRolesOf(role: string): string[];
getInheritedRolesOf(role: ValidRole): ValidRole[];
/**
* Alias of `getInheritedRolesOf`
* @private
*/
getExtendedRolesOf(role: string): string[];
getExtendedRolesOf(role: ValidRole): ValidRole[];
/**
* Gets all the unique resources that are granted access for at
* least one role.
Expand All @@ -305,7 +306,7 @@ declare class AccessControl {
*
* @returns {Boolean}
*/
hasRole(role: string | string[]): boolean;
hasRole(role: ValidRoleOrArray): boolean;
/**
* Checks whether grants include the given resource or resources.
*
Expand All @@ -314,7 +315,7 @@ declare class AccessControl {
*
* @returns {Boolean}
*/
hasResource(resource: string | string[]): boolean;
hasResource(resource: ValidRoleOrArray): boolean;
/**
* Gets an instance of `Query` object. This is used to check whether the
* defined access is allowed for the given role(s) and resource. This
Expand Down Expand Up @@ -347,12 +348,12 @@ declare class AccessControl {
* ac.can(['admin', 'user']).createOwn('profile');
* // Note: when multiple roles checked, acquired attributes are unioned (merged).
*/
can(role: string | string[] | IQueryInfo): Query;
can(role: ValidRoleOrArray | IQueryInfo): Query;
/**
* Alias of `can()`.
* @private
*/
query(role: string | string[] | IQueryInfo): Query;
query(role: ValidRoleOrArray | IQueryInfo): Query;
/**
* Gets an instance of `Permission` object that checks and defines the
* granted access permissions for the target resource and role. Normally
Expand Down Expand Up @@ -437,12 +438,12 @@ declare class AccessControl {
* // Note: when attributes is omitted, it will default to `['*']`
* // which means all attributes (of the resource) are allowed.
*/
grant(role?: string | string[] | IAccessInfo): Access;
grant(role?: ValidRoleOrArray | IAccessInfo): Access;
/**
* Alias of `grant()`.
* @private
*/
allow(role?: string | string[] | IAccessInfo): Access;
allow(role?: ValidRoleOrArray | IAccessInfo): Access;
/**
* Gets an instance of `Access` object. This is used to deny access to
* specified resource(s) for the given role(s). Denying will only remove a
Expand Down Expand Up @@ -495,31 +496,31 @@ declare class AccessControl {
* // To deny same resource for multiple roles:
* ac.deny(['admin', 'user']).createOwn('profile');
*/
deny(role?: string | string[] | IAccessInfo): Access;
deny(role?: ValidRoleOrArray | IAccessInfo): Access;
/**
* Alias of `deny()`.
* @private
*/
reject(role?: string | string[] | IAccessInfo): Access;
reject(role?: ValidRoleOrArray | IAccessInfo): Access;
/**
* @private
*/
_removePermission(resources: string | string[], roles?: string | string[], actionPossession?: string): void;
_removePermission(resources: ValidRoleOrArray, roles?: ValidRoleOrArray, actionPossession?: string): void;
/**
* Documented separately in enums/Action
* @private
*/
static readonly Action: any;
static get Action(): any;
/**
* Documented separately in enums/Possession
* @private
*/
static readonly Possession: any;
static get Possession(): any;
/**
* Documented separately in AccessControlError
* @private
*/
static readonly Error: any;
static get Error(): any;
/**
* A utility method for deep cloning the given data object(s) while
* filtering its properties by the given attribute (glob) notations.
Expand Down
21 changes: 11 additions & 10 deletions lib/AccessControl.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.AccessControl = void 0;
var core_1 = require("./core");
var enums_1 = require("./enums");
var utils_1 = require("./utils");
Expand Down Expand Up @@ -130,7 +131,7 @@ var AccessControl = /** @class */ (function () {
get: function () {
return this._isLocked && Object.isFrozen(this._grants);
},
enumerable: true,
enumerable: false,
configurable: true
});
// -------------------------------
Expand Down Expand Up @@ -287,8 +288,8 @@ var AccessControl = /** @class */ (function () {
var _this = this;
if (this.isLocked)
throw new core_1.AccessControlError(utils_1.ERR_LOCK);
var rolesToRemove = utils_1.utils.toStringArray(roles);
if (rolesToRemove.length === 0 || !utils_1.utils.isFilledStringArray(rolesToRemove)) {
var rolesToRemove = utils_1.utils.toValidRoleArray(roles);
if (rolesToRemove.length === 0 || !utils_1.utils.isFilledValidRoleArray(rolesToRemove)) {
throw new core_1.AccessControlError("Invalid role(s): " + JSON.stringify(roles));
}
rolesToRemove.forEach(function (roleName) {
Expand Down Expand Up @@ -631,15 +632,15 @@ var AccessControl = /** @class */ (function () {
*/
AccessControl.prototype._removePermission = function (resources, roles, actionPossession) {
var _this = this;
resources = utils_1.utils.toStringArray(resources);
resources = utils_1.utils.toValidRoleArray(resources);
// resources is set but returns empty array.
if (resources.length === 0 || !utils_1.utils.isFilledStringArray(resources)) {
if (resources.length === 0 || !utils_1.utils.isFilledValidRoleArray(resources)) {
throw new core_1.AccessControlError("Invalid resource(s): " + JSON.stringify(resources));
}
if (roles !== undefined) {
roles = utils_1.utils.toStringArray(roles);
roles = utils_1.utils.toValidRoleArray(roles);
// roles is set but returns empty array.
if (roles.length === 0 || !utils_1.utils.isFilledStringArray(roles)) {
if (roles.length === 0 || !utils_1.utils.isFilledValidRoleArray(roles)) {
throw new core_1.AccessControlError("Invalid role(s): " + JSON.stringify(roles));
}
}
Expand Down Expand Up @@ -673,7 +674,7 @@ var AccessControl = /** @class */ (function () {
get: function () {
return enums_1.Action;
},
enumerable: true,
enumerable: false,
configurable: true
});
Object.defineProperty(AccessControl, "Possession", {
Expand All @@ -684,7 +685,7 @@ var AccessControl = /** @class */ (function () {
get: function () {
return enums_1.Possession;
},
enumerable: true,
enumerable: false,
configurable: true
});
Object.defineProperty(AccessControl, "Error", {
Expand All @@ -695,7 +696,7 @@ var AccessControl = /** @class */ (function () {
get: function () {
return core_1.AccessControlError;
},
enumerable: true,
enumerable: false,
configurable: true
});
// -------------------------------
Expand Down
Loading