-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4425 from beyondessential/release-2023-15
Release 2023 15
- Loading branch information
Showing
302 changed files
with
8,661 additions
and
4,543 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # Ignore auto-generated files | ||
| packages/types/src/schemas/schemas.ts | ||
| packages/types/src/types/models.ts |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| /** | ||
| * Tupaia | ||
| * Copyright (c) 2017 - 2020 Beyond Essential Systems Pty Ltd | ||
| */ | ||
|
|
||
| export class AccessPolicy { | ||
| constructor(policy) { | ||
| this.policy = typeof policy === 'string' ? JSON.parse(policy) : policy; | ||
| this.validate(); | ||
| this.cachedPermissionGroupSets = {}; | ||
| } | ||
|
|
||
| validate() { | ||
| if (!this.policy) { | ||
| throw new Error('Cannot instantiate an AccessPolicy without providing the policy details'); | ||
| } | ||
| const permissionGroupLists = Object.values(this.policy); | ||
| if (permissionGroupLists.length === 0) { | ||
| throw new Error('At least one entity should be specified in an access policy'); | ||
| } | ||
| if (permissionGroupLists.some(permissionGroups => !Array.isArray(permissionGroups))) { | ||
| throw new Error( | ||
| 'Each entity should contain an array of permissionGroups for which the user has access', | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Check if the user has access to a given permission group for the given entity | ||
| * | ||
| * @param {string} [entity] | ||
| * @param {string} [permissionGroup] | ||
| * | ||
| * @returns {boolean} Whether or not the user has access to any of the entities, optionally for | ||
| * the given permission group | ||
| */ | ||
| allows(entity, permissionGroup) { | ||
| return this.allowsSome([entity], permissionGroup); | ||
| } | ||
|
|
||
| /** | ||
| * Check if the user has access to a given permission group for all of a given set of entities. | ||
| * @param {*} entities | ||
| * @param {*} permissionGroup | ||
| */ | ||
| allowsAll(entities, permissionGroup) { | ||
| if (!entities || !entities.length) { | ||
| return false; | ||
| } | ||
| return entities.every(entity => this.allows(entity, permissionGroup)); | ||
| } | ||
|
|
||
| /** | ||
| * Check if the user has access to a given permission group for any of a given set of entities e.g. | ||
| * - has access to some of the given entities with the given permission group | ||
| * accessPolicy.allowsSome(['DL', 'DL_North'], 'Donor'); | ||
| * | ||
| * - has access to the given entities with some permission group | ||
| * accessPolicy.allowsSome(['DL']); | ||
| * | ||
| * @param {string[]} [entities] | ||
| * @param {string} [permissionGroup] | ||
| * | ||
| * @returns {boolean} Whether or not the user has access to any of the entities, optionally for | ||
| * the given permission group | ||
| */ | ||
| allowsSome(entities, permissionGroup) { | ||
| if (!entities && !permissionGroup) { | ||
| return false; | ||
| } | ||
| if (!permissionGroup) { | ||
| return entities.some(entityCode => !!this.policy[entityCode]); | ||
| } | ||
|
|
||
| const allowedPermissionGroups = this.getPermissionGroupsSet(entities); | ||
| return allowedPermissionGroups.has(permissionGroup); | ||
| } | ||
|
|
||
| /** | ||
| * Returns true if the access policy grants access to any entity with the specified permission | ||
| * group | ||
| * @param {string} permissionGroup | ||
| */ | ||
| allowsAnywhere(permissionGroup) { | ||
| if (!permissionGroup) { | ||
| throw new Error('Must provide a permission group when checking allowsAnywhere'); | ||
| } | ||
| return this.getPermissionGroupsSet().has(permissionGroup); | ||
| } | ||
|
|
||
| /** | ||
| * Return permission groups the user has access to for the given entities (or all permission | ||
| * groups they can access if no entities provided) | ||
| * | ||
| * @param {string[]} [entities] | ||
| * | ||
| * @returns {string[]} The permission groups, e.g ['Admin', 'Donor'] | ||
| */ | ||
| getPermissionGroups(entities) { | ||
| return [...this.getPermissionGroupsSet(entities)]; | ||
| } | ||
|
|
||
| getPermissionGroupsSet(requestedEntities) { | ||
| // if no specific entities were requested, fetch the permissions for all of them | ||
| const entities = requestedEntities || Object.keys(this.policy); | ||
| // cache this part, as it is run often and is the most expensive operation | ||
| const cacheKey = `permissions-${entities.join('-')}`; | ||
| if (!this.cachedPermissionGroupSets[cacheKey]) { | ||
| const permissionGroups = new Set(); | ||
| entities.forEach(entityCode => { | ||
| if (this.policy[entityCode]) { | ||
| this.policy[entityCode].forEach(r => permissionGroups.add(r)); | ||
| } | ||
| }); | ||
| this.cachedPermissionGroupSets[cacheKey] = permissionGroups; | ||
| } | ||
| return this.cachedPermissionGroupSets[cacheKey]; | ||
| } | ||
|
|
||
| /** | ||
| * Return entities the user has access to the given permission group for | ||
| * | ||
| * @param {string} [permissionGroup] | ||
| * | ||
| * @returns entities[] The entity objects | ||
| */ | ||
| getEntitiesAllowed(permissionGroup) { | ||
| const allEntityCodes = Object.keys(this.policy); | ||
| if (!permissionGroup) return allEntityCodes; | ||
| return allEntityCodes.filter(e => this.allows(e, permissionGroup)); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.