Roles and permissions

<ReviseEditor
  role="suggester"
  initialDocuments={[
    { id: "contract-1", source: file },
    { id: "exhibit-a", source: exhibit, role: "viewer" }, // per document
  ]}
/>

​

Why a suggester cannot accept

​

Enforcement

• Typing and the toolbar. The document stays in a mode the role permits. setDocumentMode() clamps the requested mode: asking for "editing" as a suggester sets "suggesting". The onDocumentModeChange callback reports the resulting mode.
• The built-in chrome. The mode toggle is hidden when the role has one mode. The ribbon shows review navigation without accept and reject. The inline accept and reject tooltip on each suggestion is hidden.
• The handle. review.acceptCurrent(), acceptAll(), acceptSuggestions(), and the reject counterparts return false or a decision with every ID unresolved. Comment mutations do nothing for a viewer.
• Agent tools. tools.execute() returns { ok: false, error: { code: "role_not_permitted" } } for a mutation a viewer cannot make, and for any directMode call from a suggester. A delegated agent.run() is checked the same way.

import { ReviseRoleError } from "@reviseio/editor";

try {
  await editor.tools.execute("replace", input, { directMode: true });
} catch (error) {
  if (error instanceof ReviseRoleError) {
    // error.role === "suggester", error.action === "apply changes directly"
  }
}

​

Read the role

editor.getRole();             // active document
editor.getRole("exhibit-a");  // a specific one