@dotevolve/core

Shared types, RBAC helpers, and React authorization primitives for the DotEvolve ecosystem.

Installation

npm install @dotevolve/core

Subpath Exports

@dotevolve/core (Types)

Shared TypeScript interfaces and enums:

• Role - String enum: SUPER_ADMIN, TENANT_ADMIN, USER
• Permission - String enum with 16 namespaced permissions
• User, TenantClaim, AppMetadata - User-related interfaces
• ApiResponse<T>, PaginatedResponse<T> - API response interfaces

@dotevolve/core/auth (Auth)

RBAC constants and helper functions:

• ROLE_PERMISSIONS - Maps each Role to its set of Permissions
• SYSTEM_ROLES - Convenience constants for Role values
• hasPermission(role, permission) - Check if a role has a permission
• hasAnyPermission(role, permissions) - Check if a role has at least one permission
• hasAllPermissions(role, permissions) - Check if a role has all permissions

@dotevolve/core/react (React)

React hooks and components for authorization:

• useAuthorization(sessionOverride?) - Hook to read authorization state
• RequirePermission - Component to conditionally render based on permissions

Usage Examples

RBAC Helpers

import {
  Role,
  Permission,
  hasPermission,
  hasAnyPermission,
  hasAllPermissions,
} from "@dotevolve/core/auth";

// Check if a role has a specific permission
const canViewUsers = hasPermission(Role.TENANT_ADMIN, Permission.USERS_VIEW); // true
const canCreateUsers = hasPermission(Role.USER, Permission.USERS_CREATE); // false

// Check if a role has any of multiple permissions
const canManage = hasAnyPermission(Role.TENANT_ADMIN, [
  Permission.USERS_CREATE,
  Permission.TENANTS_CREATE,
]); // true

// Check if a role has all of multiple permissions
const canEdit = hasAllPermissions(Role.TENANT_ADMIN, [
  Permission.USERS_VIEW,
  Permission.USERS_UPDATE,
]); // true

React Hook

import { useAuthorization, Permission } from "@dotevolve/core/react";

function UserProfile() {
  const { activeRole, hasPermission } = useAuthorization();

  if (!activeRole) {
    return <div>Loading...</div>;
  }

  return (
    <div>
      <p>Role: {activeRole}</p>
      {hasPermission(Permission.USERS_VIEW) && <div>User Management</div>}
    </div>
  );
}

RequirePermission Component

import { RequirePermission, Permission } from "@dotevolve/core/react";

function AdminPanel() {
  return (
    <div>
      <RequirePermission permission={Permission.USERS_CREATE}>
        <button>Create User</button>
      </RequirePermission>

      <RequirePermission
        permission={[Permission.USERS_VIEW, Permission.USERS_UPDATE]}
        fallback={<div>Access Denied</div>}
      >
        <div>User Management Panel</div>
      </RequirePermission>
    </div>
  );
}

License

ISC