packages/dotcom-shared/src/roles.ts - main - githubmirror/tldraw

packages/dotcom-shared/src/roles.ts

46 строк2 KB

Kevin Ingersoll

feat(dotcom): rework the manage workspace dialog (#9168)

17 июн 2026, 16:28

17 июн 2026, 16:28abfa9f5

import { Capability } from './capabilities'

/**
 * Workspace authorization, expressed as capabilities rather than role names.
 *
 * Authorization asks `can(role, capability)` — never `role === 'owner'` — so the
 * meaning of a role lives in exactly one place: the `roles` table below. Read a
 * role's list to see what it can do; edit the list, or add a role, to change it.
 *
 * The role is stored in the DB as a plain string (`group_user.role`);
 * capabilities are never persisted — they're derived from that string here.
 */

/**
 * What each role can do — the single source of truth. The role name is the key,
 * and {@link Role} is derived from these keys. Today the only difference between
 * `member` and `owner` is the `manageWorkspace` capability: owners administer the
 * workspace (invite link, members' roles, name, deletion); members only work with
 * its files.
 */
const roles = {
	member: ['accessFiles', 'addFiles', 'removeFiles'],
	owner: ['accessFiles', 'addFiles', 'removeFiles', 'manageWorkspace'],
} satisfies Record<string, readonly Capability[]>

/** A role a member can have in a workspace — the string stored in `group_user.role`. */
export type Role = keyof typeof roles

/**
 * Whether a role grants a capability.
 *
 * `role` is intentionally loose (`string`): it flows straight from the DB or the
 * synced store, and any unknown or null value returns `false` rather than
 * throwing, so callers never have to validate it first.
 */
export function can(role: string | null | undefined, capability: Capability): boolean {
	if (!isRole(role)) return false
	// `satisfies` narrows each array to a tuple of its own literals, so the cast
	// widens it back to the full Capability union for `includes`.
	return (roles[role] as readonly Capability[]).includes(capability)
}

/** Whether a string is a known role name. */
export function isRole(role: string | null | undefined): role is Role {
	return role != null && Object.hasOwn(roles, role)
}