Edit

Permissions

alanning:roles package provides Reaction permissions support.

Packages

Permissions are grouped by shopId

Package specific roles can be defined in register.js, by adding custom permissions to registry entries with:

  permissions: [
    {
      label: "Custom Permission"
      permission: "custom/permission"
    }
  ]

Permission of the current route and user are compared against the package route by default, adding specific permissions to the registry entry is optional.

For using shop permissions in some packages you must add it into register directive. If we add this package then permissions will be available in Shop Accounts Settings.

Another example:

import { Reaction } from "/server/api";

Reaction.registerPackage({
  label: "Dashboard",
  name: "reaction-dashboard",
  icon: "fa fa-th",
  autoEnable: true,
  settings: {
    name: "Dashboard"
  },
  registry: [{
    provides: "dashboard",
    workflow: "coreDashboardWorkflow",
    template: "dashboardPackages",
    name: "dashboardPackages",
    label: "Core",
    description: "Reaction core shop configuration",
    icon: "fa fa-th",
    priority: 0,
    container: "core",
    permissions: [{
      label: "Dashboard",
      permission: "dashboard"
    }]
   });

At the point where Packages are published in the app, each registry item permissions are collected and put on the package registry (source). Based on these permissions, we can enable or disable functionality depending on user roles.

Owner

The initial setup user was added to the shops 'owner' permission group with the 'owner' permission.

Users with "owner" role are full-permission, app-wide users.

To check if user has owner access:

    # client / server
    import Logger from "@reactioncommerce/logger";
    import Reaction from "/imports/plugins/core/core/server/Reaction";

    if ( Reaction.hasOwnerAccess() ) {
      Logger.info("The Reaction user has Owner Access");
    }

/client/modules/core/helpers/templates.js exports the hasOwnerAccess helper.

    # template
    {{#if hasOwnerAccess}}
      <strong>This has owner access</strong>
    {{/if}}

Admin

Users with "admin" role are full-permission, site-wide users.

To check if user has admin access:

// client / server
import Logger from "@reactioncommerce/logger";
import Reaction from "/imports/plugins/core/core/server/Reaction";

if (Reaction.hasAdminAccess()) {
  Logger.info("The Reaction user has Admin Access");
}

/client/modules/core/helpers/templates.js exports the hasAdminAccess helper.

<!-- template -->
{{#if hasAdminAccess}}
  <strong>This has admin access</strong>
{{/if}}

Dashboard

Users with "dashboard" role are limited-permission, site-wide users.

To check if user has Dashboard access:

import Logger from "@reactioncommerce/logger";
import Reaction from "/imports/plugins/core/core/server/Reaction";

if (Reaction.hasDashboardAccess()) {
  Logger.info("The Reaction user has Owner Access");
}

/client/modules/core/helpers/templates.js exports the hasDashboardAccess helper.

{{#if hasDashboardAccess}}
  <strong>This has dashboard access</strong>
{{/if}}

To check if user has some specific permissions:

hasPermission

Client

// client
import Reaction from "/imports/plugins/core/core/server/Reaction";

// can be a String or Array of strings
const permissions = ["guest", "profile"];

Reaction.hasPermission(permissions);

Server

Uses the current shop and current user if either is not defined

// server
import Reaction from "/imports/plugins/core/core/server/Reaction";

// can be a String or Array of strings
const permissions = ["guest", "profile"];

Reaction.hasPermission(permissions, shop, userId);

hasPermission helper

Helpers in template in templates:

{{#if hasPermission permissions}}
  <strong> has permission </strong>
{{/if}}

/client/modules/core/helpers/permissions.js exports the hasPermission helper.

Reaction.Apps()

This core helper method gets all package apps that match the filter passed in. You can use this as in the example below to get all enabled packages for payments.

Reaction.Apps({
  provides: "paymentMethod",
  enabled: true
});

You can also pass in an audience field to filter returned apps based on assigned roles for the user. (source)

Reaction.Apps({
  provides: "settings",
  enabled: true,
  audience: Roles.getRolesForUser(Reaction.getUserId(), Reaction.getShopId())
});

Permission Groups

Permission Groups are are way to grant multiple users a group of permissions. The Accounts Dashboard provides a way to create a group and add users to them. Reaction currently ships with the four groups: Guest, Customer, Shop Manager and Owner. The Shop Manager and Owner groups are admin groups. Guest group is by default for anonymous (un-registered) users while Customer group is by default for registered users (users who created accounts).

If you installed a package that adds new permissions, you need to run:

Reaction.addRolesToGroups({
  allShops: true,
  groups: ["guest", "group"],
  roles: ["new-permission"]
});

This will add the new permissions to the group and update all existing users belonging to that group.

Updating to 1.5.0

For updating to 1.5.0, note these changes:

1. The previous shop.defaultVisitorRoles are the roles now defined in the guest group.
2. The previous shop.defaultCustomerRoles are the roles now defined in the default customer group.
3. The default roles set previously on the Shop schema are now present on server export of Reaction, Reaction.defaultVisitorRoles.

So, if you had a previous reference to shop.defaultVisitorRoles, use the group object, Groups.find({slug: "guest", shopId}).permissions.

Custom Default Groups

If you need to have more default groups on initializing your app, you can call the createGroups() method passing in the shopId and a roles object containining key-value pairs representing the group slug (key) and array of roles for the group (value). See the documentation page for more details. This can be done, for example, in an afterCoreInit function e.g

Hooks.Events.add("afterCoreInit", () => {
  Reaction.createGroups({
    shopId,
    roles: {
      influencers: [...customerRoles, ...influencerRoles]
    }
  });
});