Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 | 2x 2x 2x 2x 2x 2x 2x 58x 58x 58x 58x 5x 4x 3x 3x 2x 1x 1x 1x 1x 2x 2x 2x 2x 5x 5x 5x 4x 4x 4x 3x 1x 1x 3x 3x 2036x 3x 233x 117x 11x 11x 1x 10x 10x 10x 9x 10x 10x 2x 8x 3x 3x 3x 1x 1x 7x 2x 2x 2x 5x 5x 5x 16x 5x 5x 11x 5x 2x 4x 3x 3x 3x 3x 2x 2x 2x 3x 1x 3x | import type { CollectionConfig, CollectionBeforeDeleteHook, CollectionBeforeChangeHook, CollectionAfterChangeHook } from 'payload'
import { ValidationError, Forbidden } from 'payload'
import { checkPermission } from '../utils/checkPermission'
import { formatLabel } from '../utils/formatLabel'
import { generateCollectionPermissions } from '../utils/generatePermissions'
import { DEFAULT_SUPER_ADMIN_ROLE } from '../constants'
import { getRolesSlug } from '../utils/getRolesSlug'
import type { GatekeeperOptions } from '../types'
export const createRolesCollection = (
collections: CollectionConfig[],
options: GatekeeperOptions = {},
adminCollectionSlug?: string
): CollectionConfig => {
const rolesSlug = options.rolesSlug || 'roles'
// Create a placeholder for the roles collection itself to include in permission generation
const rolesPlaceholder: CollectionConfig = {
slug: rolesSlug,
fields: [],
}
// Include the roles collection in the permissions list
const collectionsWithRoles = [...collections, rolesPlaceholder]
return {
slug: rolesSlug,
admin: {
useAsTitle: 'label',
defaultColumns: ['label', 'name', 'permissions', 'active'],
description: 'Manage admin roles and their permissions',
group: options.rolesGroup || 'System',
// Hidden function will be added by the wrapper based on roles.manage permission
},
access: {
// All authenticated users can read roles (needed for relationships)
read: async ({ req }) => {
// Allow reading roles during first user setup
if (!req.user) {
// Check if this is the first user setup in the admin collection
// Only the admin collection (config.admin.user) matters for first user setup
if (adminCollectionSlug) {
try {
const userCount = await req.payload.count({
collection: adminCollectionSlug as 'users',
})
// Allow access only if no users exist in the admin collection
return userCount.totalDocs === 0
} catch (error) {
// If we can't count, deny access for security
console.error('Error checking admin user count for roles access:', error)
return false
}
}
// No admin collection configured, deny access
return false
}
return true
},
create: async ({ req: { user, payload } }) => {
Iif (!user || !('role' in user) || !user.role) return false
return await checkPermission(payload, user.role, 'roles.create')
},
update: async ({ req: { user, payload } }) => {
Iif (!user || !('role' in user) || !user.role) return false
return await checkPermission(payload, user.role, 'roles.update')
},
delete: async ({ req: { user, payload }, id }) => {
Iif (!user || !('role' in user) || !user.role) return false
// Check if user has delete permission
const hasDeletePermission = await checkPermission(payload, user.role, 'roles.delete')
if (!hasDeletePermission) return false
// Check if the role is protected (cannot be deleted even by super admin)
Eif (id) {
try {
const role = await payload.findByID({
collection: getRolesSlug() as 'roles',
id,
depth: 0
})
if (role?.protected) {
return false // Protected roles cannot be deleted by anyone
}
} catch (error) {
// If we can't find the role, allow the delete attempt (will fail in beforeDelete hook)
console.warn('Could not check if role is protected:', error)
}
}
return true
},
},
fields: [
// UI-only field to show protected role notice at the top of the form
{
type: 'ui',
name: 'protectedNotice',
admin: {
condition: (data) => data?.protected === true,
components: {
Field: {
path: 'payload-gatekeeper/components/ProtectedRoleNotice',
exportName: 'ProtectedRoleNotice',
},
},
},
},
{
name: 'name',
type: 'text',
required: true,
unique: true,
admin: {
description: 'Unique role identifier (e.g., super_admin, admin, editor)',
},
},
{
name: 'label',
type: 'text',
required: true,
admin: {
description: 'Display name for the role',
},
},
{
name: 'permissions',
type: 'select',
hasMany: true,
required: false,
options: generateCollectionPermissions(collectionsWithRoles, options.customPermissions).map(perm => ({
label: perm.label,
value: perm.value,
})),
admin: {
description: 'Select permissions for this role.',
className: 'permissions-select-field',
components: {
Field: {
path: 'payload-gatekeeper/components/PermissionsSelectWrapper',
exportName: 'PermissionsSelectWrapper',
},
},
},
},
{
name: 'description',
type: 'textarea',
admin: {
description: 'Optional description of the role and its purpose',
},
},
{
name: 'active',
type: 'checkbox',
defaultValue: true,
required: true,
admin: {
description: 'Inactive roles cannot be used',
condition: (data) => {
// Hide the active checkbox for protected roles (they must always be active)
return !data?.protected
},
},
},
{
name: 'protected',
type: 'checkbox',
defaultValue: false,
admin: {
hidden: true, // Hide from UI, only used internally
},
},
// System management fields for role synchronization
{
name: 'configHash',
type: 'text',
label: 'Configuration Hash',
admin: {
hidden: true,
readOnly: true,
description: 'Hash of the role configuration for version tracking',
},
},
{
name: 'configVersion',
type: 'number',
label: 'Configuration Version',
defaultValue: 0,
admin: {
hidden: true,
readOnly: true,
description: 'Version number for optimistic locking',
},
},
{
name: 'systemManaged',
type: 'checkbox',
label: 'System Managed',
defaultValue: false,
admin: {
hidden: true,
description: 'Indicates if this role is managed by the system',
},
},
{
name: 'visibleFor',
type: 'select',
hasMany: true,
required: false,
options: collections
.filter(c => c.auth === true || (c.auth && typeof c.auth === 'object'))
.map(c => ({
label: c.labels?.singular || formatLabel(c.slug),
value: c.slug,
})),
admin: {
description: 'Select which auth-enabled collections can see and assign this role. Leave empty for all auth collections.',
},
},
],
hooks: {
beforeChange: [
(async ({ data, operation, originalDoc, req }) => {
// Skip permission checks if configured
const shouldSkip =
typeof options.skipPermissionChecks === 'function'
? options.skipPermissionChecks()
: options.skipPermissionChecks
if (shouldSkip) {
return data
}
const user = req.user
// Check if current user is super admin
let isSuperAdmin = false
if (user && 'role' in user) {
isSuperAdmin = await checkPermission(
req.payload,
user.role,
'*',
user.id
)
}
// Restrict protected role updates (applies to everyone including super admins)
Eif (originalDoc?.protected && operation === 'update') {
// Prevent name changes for protected roles
if (data.name && data.name !== originalDoc.name) {
throw new ValidationError({
collection: getRolesSlug(),
errors: [
{
message: 'The name of a protected role cannot be changed.',
path: 'name',
}
]
})
}
}
// Prevent super admin from removing * permission from THEIR OWN role
if (isSuperAdmin && operation === 'update' && user) {
// Get the user's current role ID
const userRoleId = user.role && typeof user.role === 'object' && 'id' in user.role
? user.role.id
: user.role
// Check if this is the user's current role
const isUpdatingOwnRole = userRoleId === originalDoc?.id
// If updating own role and permissions are being changed
if (isUpdatingOwnRole && data.permissions !== undefined) {
Eif (!data.permissions.includes('*')) {
throw new ValidationError({
collection: getRolesSlug(),
errors: [
{
message: 'You cannot remove super admin permission from your own role. This would lock you out of the system.',
path: 'permissions',
}
]
})
}
}
}
// Super admins can update any protected roles (after checks above)
if (isSuperAdmin) {
// Ensure protected roles are always active
Eif (originalDoc?.protected && operation === 'update') {
data.active = true
}
return data
}
// Non-super admins: additional restrictions for protected roles
Eif (originalDoc?.protected && operation === 'update') {
// Filter out system fields that Payload might include
const systemFields = ['id', 'createdAt', 'updatedAt', '_status', 'configHash', 'configVersion', 'active', 'name']
const dataFields = Object.keys(data || {}).filter(
field => !systemFields.includes(field)
)
// Check if any non-allowed fields are being updated
const allowedFields = ['description', 'permissions']
const disallowedFields = dataFields.filter(
field => !allowedFields.includes(field)
)
if (disallowedFields.length > 0) {
throw new ValidationError({
collection: getRolesSlug(),
errors: disallowedFields.map(field => ({
message: `Protected roles cannot have their "${field}" field modified. Only description and permissions can be updated.`,
path: field,
}))
})
}
// Force active to true for protected roles
data.active = true
}
return data
}) satisfies CollectionBeforeChangeHook,
],
beforeDelete: [
(async ({ id, req }) => {
const doc = await req.payload.findByID({ collection: getRolesSlug() as 'roles', id })
if (doc?.protected) {
// Use Forbidden error for unauthorized deletion attempts
const error = new Forbidden()
error.message = `The role "${doc.label || doc.name}" is protected and cannot be deleted. Protected roles are essential for system operation.`
throw error
}
}) satisfies CollectionBeforeDeleteHook,
],
afterChange: [
(async ({ doc, operation }) => {
// Create super admin role if it doesn't exist
if (operation === 'create' && doc.name === DEFAULT_SUPER_ADMIN_ROLE.name) {
console.info('✅ Super Admin role created')
}
return doc
}) satisfies CollectionAfterChangeHook,
],
},
timestamps: true,
}
}
|