react-cimpress-users

Package deprecation notice

As of 2019-10-24, the team is deprecating this component library because of a newly emergent reliance on internal libraries. With this in mind, the package has been renamed and published internally. All further development of this library, including new features and bug fixes, will continue in the new repository. Thus, this repository will no longer be maintained.

You are welcome to migrate to @cimpress-technology/react-cimpress-users, sourcing it from the internal repository.

What will happen if I do nothing?

You will be using an unmaintained version of the library, which means that no support will be offered.

I am an external user without access to the internal repository. What can I do?

Unfortunately, at the time we are unable to provide you with a replacement component library. You may continue using the unmaintained library, albeit at your own risk.

react-cimpress-users

Thin React component to help managing Cimpress user access

Overview

The purpose of this package is to provide simple and embedded COAM Authorization management for React (or Vue) applications.

The UsersTable component provides the ability to add, edit or remove users within a single COAM group.

To simplify even more the access management, the component requires a list of roles that should be considered. Other existing roles will neither be shown nor managed to avoid possible conflicts.

The component was designed to fit in a Drawer, but can also be used inline (within a page) to get better experience.

Usage

Install the package:

npm install --save react-cimpress-users

Add to your code

 <UsersTable
      accessToken={this.props.accessToken}
      groupId={this.props.groupId}
      allowedRoles={[{
        roleName: 'Template Editor',
        roleCaption: 'Editor',
        isManagerRole: true
      }, {
        roleName: 'Template Reader',
        roleCaption: 'Reader',
        isManagerRole: false
      }]}
    />
    

The component requires:

• accessToken - to make sure it can communicate with COAM
• groupId - the identifier of the group that will be managed
• allowedRoles - a list of roles definition that should be managed by the component. The idea behind this list is to provide very targeted experience suitable only for the application where the component is integrated with. In majority of cases, users need to have only a few roles assigned to be able to use the application. Each role has roleName (required) that will be used to pass to COAM, roleCaption (optional) that would be used within the UI and isManagerRole (optional, default false) that will be used to color the role differently.
• showAdminsOnly - (optional, default false) Show only administrators users.
• showAdminsOnlyFilter - (optional, default true) Show a filter (checkbox) for listing only users with administrative access
• showEmail - (optional, default true) Show user email address.
• showEmailAsTooltip - (optional, default true) Show user email (based on showEmail) as a tooltip instead of inline.
• showName - (optional, default true) Show user name
• showAvatar - (optional, default true) Show user's avatar image (if exists).

Development

• Clone the repository

   git clone https://github.com/Cimpress/react-cimpress-users
   
  

• Ensure you have the following environment variables set. These are used to get Auth0 token to be able to download the translations files in the next step.

   export CLIENT_ID=<...>
   export CLIENT_SECRET=<...>
   
  

• Run the following command to download the language translations files.

   npm run build
  

• For developing, we use Storybook. You can run and see the stories with:

   npm run storybook
   
  

• Make sure your code passes the linting rules

   npm run code-check
   
  

• Make sure to update package.json with the new version of the package (please follow semantic versioning. After, please also update CHANGELOG.md file with short info for the changes in this new version.

• Don't forget to enjoy!