@edular/permissions

Shared constants and utils for permissions handling in Edular project.

How to use the library

yarn add @edular/permissions

or

npm install --save @edular/permissions

Use it in the code:

import { Permissions } from '@edular/permissions'

// ...

const doesProfileHavePermissions = profilePermissions.includes(Permissions.Admissions.Students.View)

if (doesProfileHavePermissions){
    // do something
}

Permissions

The repository contains the permissions.ts file that exports Permissions object — all available permissions. The file is generated based on the permissions list from the main Edular database.

Scripts

• build — building the library artifacts (lib/ directory)
• build:clean — clean the build directory lib/
• generate-permissions — generate permissions.ts with the Permissions object exported

How to publish new version

1. Start the edular-core and run yarn generate-permissions to generate new permissions.ts.
2. Commit the change and run npm version major|minor|patch -m "bump %s" to bump new version.
3. Publish to npm registry by running yarn publish.
4. Update the version in package.json manually or use npm for that:

npm version <major|minor|patch>

2. Commit the changes and push them to the remote repository

3. Publish new version to npm registry

npm publish