@foundrykit/permissions-plugin 0.0.0-stage → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +110 -2
- package/dist/access.d.ts +38 -0
- package/dist/access.js +119 -0
- package/dist/access.js.map +1 -0
- package/dist/audit.d.ts +25 -0
- package/dist/audit.js +95 -0
- package/dist/audit.js.map +1 -0
- package/dist/collections/PermissionOverrides.d.ts +6 -0
- package/dist/collections/PermissionOverrides.js +152 -0
- package/dist/collections/PermissionOverrides.js.map +1 -0
- package/dist/collections/Roles.d.ts +6 -0
- package/dist/collections/Roles.js +106 -0
- package/dist/collections/Roles.js.map +1 -0
- package/dist/components/NavLinks.d.ts +3 -0
- package/dist/components/NavLinks.js +20 -0
- package/dist/components/NavLinks.js.map +1 -0
- package/dist/components/PublishButtonGate.d.ts +6 -0
- package/dist/components/PublishButtonGate.js +12 -0
- package/dist/components/PublishButtonGate.js.map +1 -0
- package/dist/components/RolesMatrix.d.ts +3 -0
- package/dist/components/RolesMatrix.js +324 -0
- package/dist/components/RolesMatrix.js.map +1 -0
- package/dist/components/UsersTable.d.ts +3 -0
- package/dist/components/UsersTable.js +390 -0
- package/dist/components/UsersTable.js.map +1 -0
- package/dist/components/api.d.ts +2 -0
- package/dist/components/api.js +17 -0
- package/dist/components/api.js.map +1 -0
- package/dist/components/index.scss +335 -0
- package/dist/endpoints/resetToRole.d.ts +4 -0
- package/dist/endpoints/resetToRole.js +85 -0
- package/dist/endpoints/resetToRole.js.map +1 -0
- package/dist/exports/client.d.ts +1 -0
- package/dist/exports/client.js +3 -0
- package/dist/exports/client.js.map +1 -0
- package/dist/exports/rsc.d.ts +4 -0
- package/dist/exports/rsc.js +6 -0
- package/dist/exports/rsc.js.map +1 -0
- package/dist/index.d.ts +7 -0
- package/dist/index.js +195 -0
- package/dist/index.js.map +1 -0
- package/dist/registry.d.ts +5 -0
- package/dist/registry.js +87 -0
- package/dist/registry.js.map +1 -0
- package/dist/registry.test.d.ts +1 -0
- package/dist/resolve.d.ts +21 -0
- package/dist/resolve.js +33 -0
- package/dist/resolve.js.map +1 -0
- package/dist/resolve.test.d.ts +1 -0
- package/dist/rules.d.ts +5 -0
- package/dist/rules.js +20 -0
- package/dist/rules.js.map +1 -0
- package/dist/types.d.ts +59 -0
- package/dist/types.js +3 -0
- package/dist/types.js.map +1 -0
- package/dist/users.d.ts +3 -0
- package/dist/users.js +161 -0
- package/dist/users.js.map +1 -0
- package/dist/views/PermissionsLayout.d.ts +11 -0
- package/dist/views/PermissionsLayout.js +69 -0
- package/dist/views/PermissionsLayout.js.map +1 -0
- package/dist/views/RolesView.d.ts +2 -0
- package/dist/views/RolesView.js +20 -0
- package/dist/views/RolesView.js.map +1 -0
- package/dist/views/UsersView.d.ts +2 -0
- package/dist/views/UsersView.js +14 -0
- package/dist/views/UsersView.js.map +1 -0
- package/dist/views/data.d.ts +36 -0
- package/dist/views/data.js +58 -0
- package/dist/views/data.js.map +1 -0
- package/package.json +107 -4
package/README.md
CHANGED
|
@@ -1,3 +1,111 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @foundrykit/permissions-plugin
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Granular permissions for Payload CMS 3: `area.action` permissions, editable roles, per-user
|
|
4
|
+
overrides and an audit log of every change.
|
|
5
|
+
|
|
6
|
+
## Setup
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
import { permissionsPlugin } from '@foundrykit/permissions-plugin'
|
|
10
|
+
|
|
11
|
+
export default buildConfig({
|
|
12
|
+
plugins: [
|
|
13
|
+
permissionsPlugin({
|
|
14
|
+
areas: [
|
|
15
|
+
{ slug: 'offers', collection: 'offers', label: 'Offers' },
|
|
16
|
+
{ slug: 'settings', global: 'settings', label: 'Settings' },
|
|
17
|
+
{
|
|
18
|
+
slug: 'forms',
|
|
19
|
+
label: 'Forms & CRM',
|
|
20
|
+
customActions: { editRecipients: 'Edit enquiry recipients', resend: 'Resend CRM sends' },
|
|
21
|
+
},
|
|
22
|
+
],
|
|
23
|
+
// Umi staff: hold every permission, sit outside roles and can't be locked out.
|
|
24
|
+
isSuperAdmin: (user) =>
|
|
25
|
+
(process.env.SUPER_ADMIN_EMAILS ?? '').split(',').includes(user.email as string),
|
|
26
|
+
}),
|
|
27
|
+
],
|
|
28
|
+
})
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Run `payload generate:importmap` afterwards. The users collection must not already have `role` or
|
|
32
|
+
`lastActiveAt` fields, and no `roles`, `permission-overrides` or `permission-audit-log` collections
|
|
33
|
+
may exist.
|
|
34
|
+
|
|
35
|
+
### Areas
|
|
36
|
+
|
|
37
|
+
Each area produces permissions keyed `area.action`:
|
|
38
|
+
|
|
39
|
+
| Area maps to | Default actions |
|
|
40
|
+
| --------------------- | ------------------------------------------------------------ |
|
|
41
|
+
| a collection | `read`, `create`, `edit`, `delete` (+ `publish` with drafts) |
|
|
42
|
+
| a global | `read`, `edit` (+ `publish` with drafts) |
|
|
43
|
+
| nothing (custom area) | none, only `customActions` |
|
|
44
|
+
|
|
45
|
+
Pass `actions` to choose the standard actions explicitly. An action left out is denied for CMS
|
|
46
|
+
users. `permissions.manage` is always registered.
|
|
47
|
+
|
|
48
|
+
On Postgres, permission keys are stored as an enum, so adding an area or action needs a database
|
|
49
|
+
migration (`payload migrate:create`).
|
|
50
|
+
|
|
51
|
+
## How permissions resolve
|
|
52
|
+
|
|
53
|
+
1. Super admin → allowed.
|
|
54
|
+
2. Deny override → denied.
|
|
55
|
+
3. Allow override → allowed.
|
|
56
|
+
4. Otherwise → the user's role.
|
|
57
|
+
|
|
58
|
+
Mapped collections and globals are gated for logged-in users of the users collection. Everyone
|
|
59
|
+
else (the public site, other auth collections) keeps the entity's original access. Publishing,
|
|
60
|
+
meaning `_status` moving to `published`, also needs `area.publish`, and the publish button is
|
|
61
|
+
hidden from people without it.
|
|
62
|
+
|
|
63
|
+
Rules, enforced on the server:
|
|
64
|
+
|
|
65
|
+
- Changing roles or overrides needs `permissions.manage`.
|
|
66
|
+
- Nobody changes their own role or overrides.
|
|
67
|
+
- Nobody grants a permission they don't hold, whether by role edit, role assignment, allow
|
|
68
|
+
override or lifting a deny.
|
|
69
|
+
- A role with users can't be deleted.
|
|
70
|
+
- Changing a user's role drops the overrides the new role makes redundant.
|
|
71
|
+
|
|
72
|
+
Every change is written to the read-only **Permission audit log** collection.
|
|
73
|
+
|
|
74
|
+
## Using permissions in your own code
|
|
75
|
+
|
|
76
|
+
```ts
|
|
77
|
+
import { hasPermission, requirePermission } from '@foundrykit/permissions-plugin'
|
|
78
|
+
|
|
79
|
+
// Custom endpoint
|
|
80
|
+
if (!(await hasPermission(req, 'forms.resend'))) {
|
|
81
|
+
return Response.json({ error: 'Forbidden' }, { status: 403 })
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
// Field, collection or global access
|
|
85
|
+
{ name: 'recipients', type: 'array', access: { update: requirePermission('forms.editRecipients') } }
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## Admin UI
|
|
89
|
+
|
|
90
|
+
For people with `permissions.manage`, a **Roles & permissions** nav link opens:
|
|
91
|
+
|
|
92
|
+
- `/admin/permissions`: the roles matrix. Add, rename, duplicate and delete roles, tick
|
|
93
|
+
permissions per area, and see the impact before saving.
|
|
94
|
+
- `/admin/permissions/users`: every user with their role, override count and when they last logged in or edited. Filter
|
|
95
|
+
by role or "has overrides". Click a user to open their side panel with role picker,
|
|
96
|
+
Inherit/Allow/Deny per permission, "Reset to role" and their permission history.
|
|
97
|
+
- The audit log collection, for the full history.
|
|
98
|
+
|
|
99
|
+
## Development
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
pnpm install
|
|
103
|
+
pnpm dev # dev app on http://localhost:3000/admin (dev@payloadcms.com / test)
|
|
104
|
+
pnpm test # unit, integration and e2e (set E2E_PORT if 3000 is taken)
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
## Releasing
|
|
108
|
+
|
|
109
|
+
Run `pnpm release` on `prod`. It bumps the version, updates the changelog and pushes a `v*` tag.
|
|
110
|
+
The tag triggers `.github/workflows/publish.yml`, which publishes to npm through trusted
|
|
111
|
+
publishing, so no npm token is stored locally or in GitHub.
|
package/dist/access.d.ts
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import type { Access, Payload, PayloadRequest } from 'payload';
|
|
2
|
+
import type { Override, PluginState } from './types.js';
|
|
3
|
+
export declare const ROLES_SLUG = "roles";
|
|
4
|
+
export declare const OVERRIDES_SLUG = "permission-overrides";
|
|
5
|
+
export declare const AUDIT_SLUG = "permission-audit-log";
|
|
6
|
+
type User = {
|
|
7
|
+
collection?: string;
|
|
8
|
+
id: number | string;
|
|
9
|
+
} & Record<string, unknown>;
|
|
10
|
+
export declare const getState: (payload: Payload) => PluginState;
|
|
11
|
+
export declare const relationID: (value: unknown) => null | number | string;
|
|
12
|
+
/** A logged-in user of the collection this plugin governs. */
|
|
13
|
+
export declare const isCMSUser: (payload: Payload, user: unknown) => user is User;
|
|
14
|
+
export declare const getRolePermissions: (payload: Payload, roleID: null | number | string, req?: PayloadRequest) => Promise<string[]>;
|
|
15
|
+
export declare const getOverrides: (payload: Payload, userID: number | string, req?: PayloadRequest) => Promise<Override[]>;
|
|
16
|
+
/** Every permission the user holds, compiled from super admin, role and overrides. */
|
|
17
|
+
export declare const computePermissions: (payload: Payload, user: unknown, req?: PayloadRequest) => Promise<Set<string>>;
|
|
18
|
+
export declare const getPermissions: (req: PayloadRequest) => Promise<Set<string>>;
|
|
19
|
+
/** For custom endpoints and code: `if (!(await hasPermission(req, 'forms.resend'))) ...` */
|
|
20
|
+
export declare const hasPermission: (req: PayloadRequest, key: string) => Promise<boolean>;
|
|
21
|
+
/**
|
|
22
|
+
* Records that a CMS user was active. Writes at most every few minutes, so autosaves don't
|
|
23
|
+
* write to the user each time, and skips hooks so it never creates versions or audit entries.
|
|
24
|
+
*/
|
|
25
|
+
export declare const markActive: (req: PayloadRequest, user?: unknown) => Promise<void>;
|
|
26
|
+
/** For server components, which get `payload` and `user` but no request. */
|
|
27
|
+
export declare const userHasPermission: (payload: Payload, user: unknown, key: string) => Promise<boolean>;
|
|
28
|
+
/** Collection, global or field access that requires one permission. */
|
|
29
|
+
export declare const requirePermission: (key: string) => ({ req }: {
|
|
30
|
+
req: PayloadRequest;
|
|
31
|
+
}) => Promise<boolean>;
|
|
32
|
+
/**
|
|
33
|
+
* CMS users are judged by the permission alone. Everyone else (the public
|
|
34
|
+
* site, other auth collections) keeps the entity's original access, or
|
|
35
|
+
* Payload's default of "any logged-in user".
|
|
36
|
+
*/
|
|
37
|
+
export declare const gateAccess: (key: string, original: Access | undefined) => Access;
|
|
38
|
+
export {};
|
package/dist/access.js
ADDED
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
import { resolvePermissions } from './resolve.js';
|
|
2
|
+
export const ROLES_SLUG = 'roles';
|
|
3
|
+
export const OVERRIDES_SLUG = 'permission-overrides';
|
|
4
|
+
export const AUDIT_SLUG = 'permission-audit-log';
|
|
5
|
+
export const getState = (payload)=>{
|
|
6
|
+
const state = payload.config.custom?.permissions;
|
|
7
|
+
if (!state) {
|
|
8
|
+
throw new Error('permissions: permissionsPlugin() is not installed');
|
|
9
|
+
}
|
|
10
|
+
return state;
|
|
11
|
+
};
|
|
12
|
+
export const relationID = (value)=>{
|
|
13
|
+
if (value && typeof value === 'object' && 'id' in value) {
|
|
14
|
+
return value.id;
|
|
15
|
+
}
|
|
16
|
+
return value ?? null;
|
|
17
|
+
};
|
|
18
|
+
/** A logged-in user of the collection this plugin governs. */ export const isCMSUser = (payload, user)=>Boolean(user && user.collection === getState(payload).usersSlug);
|
|
19
|
+
export const getRolePermissions = async (payload, roleID, req)=>{
|
|
20
|
+
if (roleID === null) {
|
|
21
|
+
return [];
|
|
22
|
+
}
|
|
23
|
+
const { docs } = await payload.find({
|
|
24
|
+
collection: ROLES_SLUG,
|
|
25
|
+
depth: 0,
|
|
26
|
+
limit: 1,
|
|
27
|
+
overrideAccess: true,
|
|
28
|
+
req,
|
|
29
|
+
where: {
|
|
30
|
+
id: {
|
|
31
|
+
equals: roleID
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
});
|
|
35
|
+
return (docs[0]?.permissions ?? []).slice();
|
|
36
|
+
};
|
|
37
|
+
export const getOverrides = async (payload, userID, req)=>{
|
|
38
|
+
const { docs } = await payload.find({
|
|
39
|
+
collection: OVERRIDES_SLUG,
|
|
40
|
+
depth: 0,
|
|
41
|
+
overrideAccess: true,
|
|
42
|
+
pagination: false,
|
|
43
|
+
req,
|
|
44
|
+
where: {
|
|
45
|
+
user: {
|
|
46
|
+
equals: userID
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
});
|
|
50
|
+
return docs;
|
|
51
|
+
};
|
|
52
|
+
/** Every permission the user holds, compiled from super admin, role and overrides. */ export const computePermissions = async (payload, user, req)=>{
|
|
53
|
+
if (!isCMSUser(payload, user)) {
|
|
54
|
+
return new Set();
|
|
55
|
+
}
|
|
56
|
+
const { isSuperAdmin, keys } = getState(payload);
|
|
57
|
+
if (isSuperAdmin(user)) {
|
|
58
|
+
return new Set(keys);
|
|
59
|
+
}
|
|
60
|
+
const rolePermissions = await getRolePermissions(payload, relationID(user.role), req);
|
|
61
|
+
const overrides = await getOverrides(payload, user.id, req);
|
|
62
|
+
return resolvePermissions(keys, {
|
|
63
|
+
overrides,
|
|
64
|
+
rolePermissions,
|
|
65
|
+
superAdmin: false
|
|
66
|
+
});
|
|
67
|
+
};
|
|
68
|
+
// ponytail: compiled once per request (two small queries) rather than stored on
|
|
69
|
+
// the user; store it on the user doc if this ever shows up in profiles.
|
|
70
|
+
const compiled = new WeakMap();
|
|
71
|
+
export const getPermissions = (req)=>{
|
|
72
|
+
let permissions = compiled.get(req);
|
|
73
|
+
if (!permissions) {
|
|
74
|
+
// Outside the request's transaction: Payload runs field access in parallel, and
|
|
75
|
+
// Mongo rejects concurrent operations that race to start a transaction. The
|
|
76
|
+
// actor's own role and overrides can't change mid-request (self-edits are banned).
|
|
77
|
+
permissions = computePermissions(req.payload, req.user);
|
|
78
|
+
compiled.set(req, permissions);
|
|
79
|
+
}
|
|
80
|
+
return permissions;
|
|
81
|
+
};
|
|
82
|
+
/** For custom endpoints and code: `if (!(await hasPermission(req, 'forms.resend'))) ...` */ export const hasPermission = async (req, key)=>isCMSUser(req.payload, req.user) && getState(req.payload).isSuperAdmin(req.user) || (await getPermissions(req)).has(key);
|
|
83
|
+
const ACTIVE_EVERY_MS = 5 * 60 * 1000;
|
|
84
|
+
/**
|
|
85
|
+
* Records that a CMS user was active. Writes at most every few minutes, so autosaves don't
|
|
86
|
+
* write to the user each time, and skips hooks so it never creates versions or audit entries.
|
|
87
|
+
*/ export const markActive = async (req, user = req.user)=>{
|
|
88
|
+
if (!isCMSUser(req.payload, user)) {
|
|
89
|
+
return;
|
|
90
|
+
}
|
|
91
|
+
const last = typeof user.lastActiveAt === 'string' ? Date.parse(user.lastActiveAt) : 0;
|
|
92
|
+
if (Date.now() - last < ACTIVE_EVERY_MS) {
|
|
93
|
+
return;
|
|
94
|
+
}
|
|
95
|
+
const now = new Date().toISOString();
|
|
96
|
+
await req.payload.db.updateOne({
|
|
97
|
+
id: user.id,
|
|
98
|
+
collection: getState(req.payload).usersSlug,
|
|
99
|
+
data: {
|
|
100
|
+
lastActiveAt: now
|
|
101
|
+
},
|
|
102
|
+
req
|
|
103
|
+
});
|
|
104
|
+
user.lastActiveAt = now;
|
|
105
|
+
};
|
|
106
|
+
/** For server components, which get `payload` and `user` but no request. */ export const userHasPermission = async (payload, user, key)=>isCMSUser(payload, user) && (getState(payload).isSuperAdmin(user) || (await computePermissions(payload, user)).has(key));
|
|
107
|
+
/** Collection, global or field access that requires one permission. */ export const requirePermission = (key)=>({ req })=>hasPermission(req, key);
|
|
108
|
+
/**
|
|
109
|
+
* CMS users are judged by the permission alone. Everyone else (the public
|
|
110
|
+
* site, other auth collections) keeps the entity's original access, or
|
|
111
|
+
* Payload's default of "any logged-in user".
|
|
112
|
+
*/ export const gateAccess = (key, original)=>(args)=>{
|
|
113
|
+
if (isCMSUser(args.req.payload, args.req.user)) {
|
|
114
|
+
return hasPermission(args.req, key);
|
|
115
|
+
}
|
|
116
|
+
return original ? original(args) : Boolean(args.req.user);
|
|
117
|
+
};
|
|
118
|
+
|
|
119
|
+
//# sourceMappingURL=access.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/access.ts"],"sourcesContent":["import type { Access, Payload, PayloadRequest } from 'payload'\n\nimport type { Override, PluginState } from './types.js'\n\nimport { resolvePermissions } from './resolve.js'\n\nexport const ROLES_SLUG = 'roles'\nexport const OVERRIDES_SLUG = 'permission-overrides'\nexport const AUDIT_SLUG = 'permission-audit-log'\n\ntype User = { collection?: string; id: number | string } & Record<string, unknown>\n\nexport const getState = (payload: Payload): PluginState => {\n const state = payload.config.custom?.permissions as PluginState | undefined\n if (!state) {\n throw new Error('permissions: permissionsPlugin() is not installed')\n }\n return state\n}\n\nexport const relationID = (value: unknown): null | number | string => {\n if (value && typeof value === 'object' && 'id' in value) {\n return value.id as number | string\n }\n return (value as null | number | string | undefined) ?? null\n}\n\n/** A logged-in user of the collection this plugin governs. */\nexport const isCMSUser = (payload: Payload, user: unknown): user is User =>\n Boolean(user && (user as User).collection === getState(payload).usersSlug)\n\nexport const getRolePermissions = async (\n payload: Payload,\n roleID: null | number | string,\n req?: PayloadRequest,\n): Promise<string[]> => {\n if (roleID === null) {\n return []\n }\n const { docs } = await payload.find({\n collection: ROLES_SLUG,\n depth: 0,\n limit: 1,\n overrideAccess: true,\n req,\n where: { id: { equals: roleID } },\n })\n return ((docs[0]?.permissions as string[] | undefined) ?? []).slice()\n}\n\nexport const getOverrides = async (\n payload: Payload,\n userID: number | string,\n req?: PayloadRequest,\n): Promise<Override[]> => {\n const { docs } = await payload.find({\n collection: OVERRIDES_SLUG,\n depth: 0,\n overrideAccess: true,\n pagination: false,\n req,\n where: { user: { equals: userID } },\n })\n return docs as unknown as Override[]\n}\n\n/** Every permission the user holds, compiled from super admin, role and overrides. */\nexport const computePermissions = async (\n payload: Payload,\n user: unknown,\n req?: PayloadRequest,\n): Promise<Set<string>> => {\n if (!isCMSUser(payload, user)) {\n return new Set()\n }\n const { isSuperAdmin, keys } = getState(payload)\n if (isSuperAdmin(user)) {\n return new Set(keys)\n }\n const rolePermissions = await getRolePermissions(payload, relationID(user.role), req)\n const overrides = await getOverrides(payload, user.id, req)\n return resolvePermissions(keys, { overrides, rolePermissions, superAdmin: false })\n}\n\n// ponytail: compiled once per request (two small queries) rather than stored on\n// the user; store it on the user doc if this ever shows up in profiles.\nconst compiled = new WeakMap<PayloadRequest, Promise<Set<string>>>()\n\nexport const getPermissions = (req: PayloadRequest): Promise<Set<string>> => {\n let permissions = compiled.get(req)\n if (!permissions) {\n // Outside the request's transaction: Payload runs field access in parallel, and\n // Mongo rejects concurrent operations that race to start a transaction. The\n // actor's own role and overrides can't change mid-request (self-edits are banned).\n permissions = computePermissions(req.payload, req.user)\n compiled.set(req, permissions)\n }\n return permissions\n}\n\n/** For custom endpoints and code: `if (!(await hasPermission(req, 'forms.resend'))) ...` */\nexport const hasPermission = async (req: PayloadRequest, key: string): Promise<boolean> =>\n (isCMSUser(req.payload, req.user) && getState(req.payload).isSuperAdmin(req.user)) ||\n (await getPermissions(req)).has(key)\n\nconst ACTIVE_EVERY_MS = 5 * 60 * 1000\n\n/**\n * Records that a CMS user was active. Writes at most every few minutes, so autosaves don't\n * write to the user each time, and skips hooks so it never creates versions or audit entries.\n */\nexport const markActive = async (req: PayloadRequest, user: unknown = req.user) => {\n if (!isCMSUser(req.payload, user)) {\n return\n }\n const last = typeof user.lastActiveAt === 'string' ? Date.parse(user.lastActiveAt) : 0\n if (Date.now() - last < ACTIVE_EVERY_MS) {\n return\n }\n const now = new Date().toISOString()\n await req.payload.db.updateOne({\n id: user.id,\n collection: getState(req.payload).usersSlug,\n data: { lastActiveAt: now },\n req,\n })\n user.lastActiveAt = now\n}\n\n/** For server components, which get `payload` and `user` but no request. */\nexport const userHasPermission = async (\n payload: Payload,\n user: unknown,\n key: string,\n): Promise<boolean> =>\n isCMSUser(payload, user) &&\n (getState(payload).isSuperAdmin(user) || (await computePermissions(payload, user)).has(key))\n\n/** Collection, global or field access that requires one permission. */\nexport const requirePermission =\n (key: string) =>\n ({ req }: { req: PayloadRequest }): Promise<boolean> =>\n hasPermission(req, key)\n\n/**\n * CMS users are judged by the permission alone. Everyone else (the public\n * site, other auth collections) keeps the entity's original access, or\n * Payload's default of \"any logged-in user\".\n */\nexport const gateAccess =\n (key: string, original: Access | undefined): Access =>\n (args) => {\n if (isCMSUser(args.req.payload, args.req.user)) {\n return hasPermission(args.req, key)\n }\n return original ? original(args) : Boolean(args.req.user)\n }\n"],"names":["resolvePermissions","ROLES_SLUG","OVERRIDES_SLUG","AUDIT_SLUG","getState","payload","state","config","custom","permissions","Error","relationID","value","id","isCMSUser","user","Boolean","collection","usersSlug","getRolePermissions","roleID","req","docs","find","depth","limit","overrideAccess","where","equals","slice","getOverrides","userID","pagination","computePermissions","Set","isSuperAdmin","keys","rolePermissions","role","overrides","superAdmin","compiled","WeakMap","getPermissions","get","set","hasPermission","key","has","ACTIVE_EVERY_MS","markActive","last","lastActiveAt","Date","parse","now","toISOString","db","updateOne","data","userHasPermission","requirePermission","gateAccess","original","args"],"mappings":"AAIA,SAASA,kBAAkB,QAAQ,eAAc;AAEjD,OAAO,MAAMC,aAAa,QAAO;AACjC,OAAO,MAAMC,iBAAiB,uBAAsB;AACpD,OAAO,MAAMC,aAAa,uBAAsB;AAIhD,OAAO,MAAMC,WAAW,CAACC;IACvB,MAAMC,QAAQD,QAAQE,MAAM,CAACC,MAAM,EAAEC;IACrC,IAAI,CAACH,OAAO;QACV,MAAM,IAAII,MAAM;IAClB;IACA,OAAOJ;AACT,EAAC;AAED,OAAO,MAAMK,aAAa,CAACC;IACzB,IAAIA,SAAS,OAAOA,UAAU,YAAY,QAAQA,OAAO;QACvD,OAAOA,MAAMC,EAAE;IACjB;IACA,OAAO,AAACD,SAAgD;AAC1D,EAAC;AAED,4DAA4D,GAC5D,OAAO,MAAME,YAAY,CAACT,SAAkBU,OAC1CC,QAAQD,QAAQ,AAACA,KAAcE,UAAU,KAAKb,SAASC,SAASa,SAAS,EAAC;AAE5E,OAAO,MAAMC,qBAAqB,OAChCd,SACAe,QACAC;IAEA,IAAID,WAAW,MAAM;QACnB,OAAO,EAAE;IACX;IACA,MAAM,EAAEE,IAAI,EAAE,GAAG,MAAMjB,QAAQkB,IAAI,CAAC;QAClCN,YAAYhB;QACZuB,OAAO;QACPC,OAAO;QACPC,gBAAgB;QAChBL;QACAM,OAAO;YAAEd,IAAI;gBAAEe,QAAQR;YAAO;QAAE;IAClC;IACA,OAAO,AAAC,CAAA,AAACE,IAAI,CAAC,EAAE,EAAEb,eAAwC,EAAE,AAAD,EAAGoB,KAAK;AACrE,EAAC;AAED,OAAO,MAAMC,eAAe,OAC1BzB,SACA0B,QACAV;IAEA,MAAM,EAAEC,IAAI,EAAE,GAAG,MAAMjB,QAAQkB,IAAI,CAAC;QAClCN,YAAYf;QACZsB,OAAO;QACPE,gBAAgB;QAChBM,YAAY;QACZX;QACAM,OAAO;YAAEZ,MAAM;gBAAEa,QAAQG;YAAO;QAAE;IACpC;IACA,OAAOT;AACT,EAAC;AAED,oFAAoF,GACpF,OAAO,MAAMW,qBAAqB,OAChC5B,SACAU,MACAM;IAEA,IAAI,CAACP,UAAUT,SAASU,OAAO;QAC7B,OAAO,IAAImB;IACb;IACA,MAAM,EAAEC,YAAY,EAAEC,IAAI,EAAE,GAAGhC,SAASC;IACxC,IAAI8B,aAAapB,OAAO;QACtB,OAAO,IAAImB,IAAIE;IACjB;IACA,MAAMC,kBAAkB,MAAMlB,mBAAmBd,SAASM,WAAWI,KAAKuB,IAAI,GAAGjB;IACjF,MAAMkB,YAAY,MAAMT,aAAazB,SAASU,KAAKF,EAAE,EAAEQ;IACvD,OAAOrB,mBAAmBoC,MAAM;QAAEG;QAAWF;QAAiBG,YAAY;IAAM;AAClF,EAAC;AAED,gFAAgF;AAChF,wEAAwE;AACxE,MAAMC,WAAW,IAAIC;AAErB,OAAO,MAAMC,iBAAiB,CAACtB;IAC7B,IAAIZ,cAAcgC,SAASG,GAAG,CAACvB;IAC/B,IAAI,CAACZ,aAAa;QAChB,gFAAgF;QAChF,4EAA4E;QAC5E,mFAAmF;QACnFA,cAAcwB,mBAAmBZ,IAAIhB,OAAO,EAAEgB,IAAIN,IAAI;QACtD0B,SAASI,GAAG,CAACxB,KAAKZ;IACpB;IACA,OAAOA;AACT,EAAC;AAED,0FAA0F,GAC1F,OAAO,MAAMqC,gBAAgB,OAAOzB,KAAqB0B,MACvD,AAACjC,UAAUO,IAAIhB,OAAO,EAAEgB,IAAIN,IAAI,KAAKX,SAASiB,IAAIhB,OAAO,EAAE8B,YAAY,CAACd,IAAIN,IAAI,KAChF,AAAC,CAAA,MAAM4B,eAAetB,IAAG,EAAG2B,GAAG,CAACD,KAAI;AAEtC,MAAME,kBAAkB,IAAI,KAAK;AAEjC;;;CAGC,GACD,OAAO,MAAMC,aAAa,OAAO7B,KAAqBN,OAAgBM,IAAIN,IAAI;IAC5E,IAAI,CAACD,UAAUO,IAAIhB,OAAO,EAAEU,OAAO;QACjC;IACF;IACA,MAAMoC,OAAO,OAAOpC,KAAKqC,YAAY,KAAK,WAAWC,KAAKC,KAAK,CAACvC,KAAKqC,YAAY,IAAI;IACrF,IAAIC,KAAKE,GAAG,KAAKJ,OAAOF,iBAAiB;QACvC;IACF;IACA,MAAMM,MAAM,IAAIF,OAAOG,WAAW;IAClC,MAAMnC,IAAIhB,OAAO,CAACoD,EAAE,CAACC,SAAS,CAAC;QAC7B7C,IAAIE,KAAKF,EAAE;QACXI,YAAYb,SAASiB,IAAIhB,OAAO,EAAEa,SAAS;QAC3CyC,MAAM;YAAEP,cAAcG;QAAI;QAC1BlC;IACF;IACAN,KAAKqC,YAAY,GAAGG;AACtB,EAAC;AAED,0EAA0E,GAC1E,OAAO,MAAMK,oBAAoB,OAC/BvD,SACAU,MACAgC,MAEAjC,UAAUT,SAASU,SAClBX,CAAAA,SAASC,SAAS8B,YAAY,CAACpB,SAAS,AAAC,CAAA,MAAMkB,mBAAmB5B,SAASU,KAAI,EAAGiC,GAAG,CAACD,IAAG,EAAE;AAE9F,qEAAqE,GACrE,OAAO,MAAMc,oBACX,CAACd,MACD,CAAC,EAAE1B,GAAG,EAA2B,GAC/ByB,cAAczB,KAAK0B,KAAI;AAE3B;;;;CAIC,GACD,OAAO,MAAMe,aACX,CAACf,KAAagB,WACd,CAACC;QACC,IAAIlD,UAAUkD,KAAK3C,GAAG,CAAChB,OAAO,EAAE2D,KAAK3C,GAAG,CAACN,IAAI,GAAG;YAC9C,OAAO+B,cAAckB,KAAK3C,GAAG,EAAE0B;QACjC;QACA,OAAOgB,WAAWA,SAASC,QAAQhD,QAAQgD,KAAK3C,GAAG,CAACN,IAAI;IAC1D,EAAC"}
|
package/dist/audit.d.ts
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import type { CollectionConfig, CollectionSlug, PayloadRequest } from 'payload';
|
|
2
|
+
export declare const AUDIT_ACTIONS: {
|
|
3
|
+
readonly 'override.add': "Override added";
|
|
4
|
+
readonly 'override.change': "Override changed";
|
|
5
|
+
readonly 'override.remove': "Override removed";
|
|
6
|
+
readonly 'role.create': "Role created";
|
|
7
|
+
readonly 'role.delete': "Role deleted";
|
|
8
|
+
readonly 'role.update': "Role edited";
|
|
9
|
+
readonly 'user.reset': "Reset to role";
|
|
10
|
+
readonly 'user.role': "Role assigned";
|
|
11
|
+
};
|
|
12
|
+
export type AuditAction = keyof typeof AUDIT_ACTIONS;
|
|
13
|
+
type AuditEntry = {
|
|
14
|
+
action: AuditAction;
|
|
15
|
+
after?: unknown;
|
|
16
|
+
before?: unknown;
|
|
17
|
+
role?: null | number | string;
|
|
18
|
+
summary: string;
|
|
19
|
+
user?: null | number | string;
|
|
20
|
+
};
|
|
21
|
+
/** Set in `context` for writes that are part of a change already checked and audited. */
|
|
22
|
+
export declare const PART_OF_CHANGE = "permissionsPartOfChange";
|
|
23
|
+
export declare const writeAudit: (req: PayloadRequest, entry: AuditEntry) => Promise<void>;
|
|
24
|
+
export declare const createAuditCollection: (usersSlug: CollectionSlug) => CollectionConfig;
|
|
25
|
+
export {};
|
package/dist/audit.js
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
import { AUDIT_SLUG, isCMSUser, requirePermission, ROLES_SLUG } from './access.js';
|
|
2
|
+
import { MANAGE_PERMISSION } from './registry.js';
|
|
3
|
+
export const AUDIT_ACTIONS = {
|
|
4
|
+
'override.add': 'Override added',
|
|
5
|
+
'override.change': 'Override changed',
|
|
6
|
+
'override.remove': 'Override removed',
|
|
7
|
+
'role.create': 'Role created',
|
|
8
|
+
'role.delete': 'Role deleted',
|
|
9
|
+
'role.update': 'Role edited',
|
|
10
|
+
'user.reset': 'Reset to role',
|
|
11
|
+
'user.role': 'Role assigned'
|
|
12
|
+
};
|
|
13
|
+
/** Set in `context` for writes that are part of a change already checked and audited. */ export const PART_OF_CHANGE = 'permissionsPartOfChange';
|
|
14
|
+
export const writeAudit = async (req, entry)=>{
|
|
15
|
+
await req.payload.create({
|
|
16
|
+
collection: AUDIT_SLUG,
|
|
17
|
+
// Typed loosely: the plugin can't see a site's generated types.
|
|
18
|
+
data: {
|
|
19
|
+
...entry,
|
|
20
|
+
actor: isCMSUser(req.payload, req.user) ? req.user.id : null
|
|
21
|
+
},
|
|
22
|
+
depth: 0,
|
|
23
|
+
overrideAccess: true,
|
|
24
|
+
req
|
|
25
|
+
});
|
|
26
|
+
};
|
|
27
|
+
export const createAuditCollection = (usersSlug)=>({
|
|
28
|
+
slug: AUDIT_SLUG,
|
|
29
|
+
access: {
|
|
30
|
+
create: ()=>false,
|
|
31
|
+
delete: ()=>false,
|
|
32
|
+
read: requirePermission(MANAGE_PERMISSION),
|
|
33
|
+
update: ()=>false
|
|
34
|
+
},
|
|
35
|
+
admin: {
|
|
36
|
+
defaultColumns: [
|
|
37
|
+
'summary',
|
|
38
|
+
'action',
|
|
39
|
+
'user',
|
|
40
|
+
'actor',
|
|
41
|
+
'createdAt'
|
|
42
|
+
],
|
|
43
|
+
group: 'Permissions',
|
|
44
|
+
useAsTitle: 'summary'
|
|
45
|
+
},
|
|
46
|
+
fields: [
|
|
47
|
+
{
|
|
48
|
+
name: 'summary',
|
|
49
|
+
type: 'text',
|
|
50
|
+
required: true
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
name: 'action',
|
|
54
|
+
type: 'select',
|
|
55
|
+
index: true,
|
|
56
|
+
options: Object.entries(AUDIT_ACTIONS).map(([value, label])=>({
|
|
57
|
+
label,
|
|
58
|
+
value
|
|
59
|
+
})),
|
|
60
|
+
required: true
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
name: 'actor',
|
|
64
|
+
type: 'relationship',
|
|
65
|
+
relationTo: usersSlug
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
name: 'user',
|
|
69
|
+
type: 'relationship',
|
|
70
|
+
index: true,
|
|
71
|
+
label: 'Affected user',
|
|
72
|
+
relationTo: usersSlug
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
name: 'role',
|
|
76
|
+
type: 'relationship',
|
|
77
|
+
relationTo: ROLES_SLUG
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
name: 'before',
|
|
81
|
+
type: 'json'
|
|
82
|
+
},
|
|
83
|
+
{
|
|
84
|
+
name: 'after',
|
|
85
|
+
type: 'json'
|
|
86
|
+
}
|
|
87
|
+
],
|
|
88
|
+
labels: {
|
|
89
|
+
plural: 'Permission audit log',
|
|
90
|
+
singular: 'Permission change'
|
|
91
|
+
},
|
|
92
|
+
timestamps: true
|
|
93
|
+
});
|
|
94
|
+
|
|
95
|
+
//# sourceMappingURL=audit.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/audit.ts"],"sourcesContent":["import type { CollectionConfig, CollectionSlug, PayloadRequest } from 'payload'\n\nimport { AUDIT_SLUG, isCMSUser, requirePermission, ROLES_SLUG } from './access.js'\nimport { MANAGE_PERMISSION } from './registry.js'\n\nexport const AUDIT_ACTIONS = {\n 'override.add': 'Override added',\n 'override.change': 'Override changed',\n 'override.remove': 'Override removed',\n 'role.create': 'Role created',\n 'role.delete': 'Role deleted',\n 'role.update': 'Role edited',\n 'user.reset': 'Reset to role',\n 'user.role': 'Role assigned',\n} as const\n\nexport type AuditAction = keyof typeof AUDIT_ACTIONS\n\ntype AuditEntry = {\n action: AuditAction\n after?: unknown\n before?: unknown\n role?: null | number | string\n summary: string\n user?: null | number | string\n}\n\n/** Set in `context` for writes that are part of a change already checked and audited. */\nexport const PART_OF_CHANGE = 'permissionsPartOfChange'\n\nexport const writeAudit = async (req: PayloadRequest, entry: AuditEntry) => {\n await req.payload.create({\n collection: AUDIT_SLUG,\n // Typed loosely: the plugin can't see a site's generated types.\n data: {\n ...entry,\n actor: isCMSUser(req.payload, req.user) ? req.user.id : null,\n } as never,\n depth: 0,\n overrideAccess: true,\n req,\n })\n}\n\nexport const createAuditCollection = (usersSlug: CollectionSlug): CollectionConfig => ({\n slug: AUDIT_SLUG,\n access: {\n create: () => false,\n delete: () => false,\n read: requirePermission(MANAGE_PERMISSION),\n update: () => false,\n },\n admin: {\n defaultColumns: ['summary', 'action', 'user', 'actor', 'createdAt'],\n group: 'Permissions',\n useAsTitle: 'summary',\n },\n fields: [\n { name: 'summary', type: 'text', required: true },\n {\n name: 'action',\n type: 'select',\n index: true,\n options: Object.entries(AUDIT_ACTIONS).map(([value, label]) => ({ label, value })),\n required: true,\n },\n { name: 'actor', type: 'relationship', relationTo: usersSlug },\n {\n name: 'user',\n type: 'relationship',\n index: true,\n label: 'Affected user',\n relationTo: usersSlug,\n },\n { name: 'role', type: 'relationship', relationTo: ROLES_SLUG },\n { name: 'before', type: 'json' },\n { name: 'after', type: 'json' },\n ],\n labels: { plural: 'Permission audit log', singular: 'Permission change' },\n timestamps: true,\n})\n"],"names":["AUDIT_SLUG","isCMSUser","requirePermission","ROLES_SLUG","MANAGE_PERMISSION","AUDIT_ACTIONS","PART_OF_CHANGE","writeAudit","req","entry","payload","create","collection","data","actor","user","id","depth","overrideAccess","createAuditCollection","usersSlug","slug","access","delete","read","update","admin","defaultColumns","group","useAsTitle","fields","name","type","required","index","options","Object","entries","map","value","label","relationTo","labels","plural","singular","timestamps"],"mappings":"AAEA,SAASA,UAAU,EAAEC,SAAS,EAAEC,iBAAiB,EAAEC,UAAU,QAAQ,cAAa;AAClF,SAASC,iBAAiB,QAAQ,gBAAe;AAEjD,OAAO,MAAMC,gBAAgB;IAC3B,gBAAgB;IAChB,mBAAmB;IACnB,mBAAmB;IACnB,eAAe;IACf,eAAe;IACf,eAAe;IACf,cAAc;IACd,aAAa;AACf,EAAU;AAaV,uFAAuF,GACvF,OAAO,MAAMC,iBAAiB,0BAAyB;AAEvD,OAAO,MAAMC,aAAa,OAAOC,KAAqBC;IACpD,MAAMD,IAAIE,OAAO,CAACC,MAAM,CAAC;QACvBC,YAAYZ;QACZ,gEAAgE;QAChEa,MAAM;YACJ,GAAGJ,KAAK;YACRK,OAAOb,UAAUO,IAAIE,OAAO,EAAEF,IAAIO,IAAI,IAAIP,IAAIO,IAAI,CAACC,EAAE,GAAG;QAC1D;QACAC,OAAO;QACPC,gBAAgB;QAChBV;IACF;AACF,EAAC;AAED,OAAO,MAAMW,wBAAwB,CAACC,YAAiD,CAAA;QACrFC,MAAMrB;QACNsB,QAAQ;YACNX,QAAQ,IAAM;YACdY,QAAQ,IAAM;YACdC,MAAMtB,kBAAkBE;YACxBqB,QAAQ,IAAM;QAChB;QACAC,OAAO;YACLC,gBAAgB;gBAAC;gBAAW;gBAAU;gBAAQ;gBAAS;aAAY;YACnEC,OAAO;YACPC,YAAY;QACd;QACAC,QAAQ;YACN;gBAAEC,MAAM;gBAAWC,MAAM;gBAAQC,UAAU;YAAK;YAChD;gBACEF,MAAM;gBACNC,MAAM;gBACNE,OAAO;gBACPC,SAASC,OAAOC,OAAO,CAAChC,eAAeiC,GAAG,CAAC,CAAC,CAACC,OAAOC,MAAM,GAAM,CAAA;wBAAEA;wBAAOD;oBAAM,CAAA;gBAC/EN,UAAU;YACZ;YACA;gBAAEF,MAAM;gBAASC,MAAM;gBAAgBS,YAAYrB;YAAU;YAC7D;gBACEW,MAAM;gBACNC,MAAM;gBACNE,OAAO;gBACPM,OAAO;gBACPC,YAAYrB;YACd;YACA;gBAAEW,MAAM;gBAAQC,MAAM;gBAAgBS,YAAYtC;YAAW;YAC7D;gBAAE4B,MAAM;gBAAUC,MAAM;YAAO;YAC/B;gBAAED,MAAM;gBAASC,MAAM;YAAO;SAC/B;QACDU,QAAQ;YAAEC,QAAQ;YAAwBC,UAAU;QAAoB;QACxEC,YAAY;IACd,CAAA,EAAE"}
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
import { hasPermission, isCMSUser, OVERRIDES_SLUG, relationID, requirePermission } from '../access.js';
|
|
2
|
+
import { PART_OF_CHANGE, writeAudit } from '../audit.js';
|
|
3
|
+
import { MANAGE_PERMISSION } from '../registry.js';
|
|
4
|
+
import { assertCanGrant, assertNotSelf } from '../rules.js';
|
|
5
|
+
const snapshot = (doc)=>({
|
|
6
|
+
effect: doc.effect,
|
|
7
|
+
permission: doc.permission
|
|
8
|
+
});
|
|
9
|
+
export const createOverridesCollection = ({ registry, usersSlug })=>({
|
|
10
|
+
slug: OVERRIDES_SLUG,
|
|
11
|
+
access: {
|
|
12
|
+
create: requirePermission(MANAGE_PERMISSION),
|
|
13
|
+
delete: requirePermission(MANAGE_PERMISSION),
|
|
14
|
+
// Managers see every override; other CMS users only their own.
|
|
15
|
+
read: async ({ req })=>{
|
|
16
|
+
if (await hasPermission(req, MANAGE_PERMISSION)) {
|
|
17
|
+
return true;
|
|
18
|
+
}
|
|
19
|
+
return isCMSUser(req.payload, req.user) ? {
|
|
20
|
+
user: {
|
|
21
|
+
equals: req.user.id
|
|
22
|
+
}
|
|
23
|
+
} : false;
|
|
24
|
+
},
|
|
25
|
+
update: requirePermission(MANAGE_PERMISSION)
|
|
26
|
+
},
|
|
27
|
+
admin: {
|
|
28
|
+
// Edited through the user panel.
|
|
29
|
+
hidden: true
|
|
30
|
+
},
|
|
31
|
+
fields: [
|
|
32
|
+
{
|
|
33
|
+
name: 'user',
|
|
34
|
+
type: 'relationship',
|
|
35
|
+
index: true,
|
|
36
|
+
relationTo: usersSlug,
|
|
37
|
+
required: true
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
name: 'permission',
|
|
41
|
+
type: 'select',
|
|
42
|
+
options: registry.flatMap((area)=>area.permissions.map((p)=>({
|
|
43
|
+
label: `${area.label} · ${p.label}`,
|
|
44
|
+
value: p.key
|
|
45
|
+
}))),
|
|
46
|
+
required: true
|
|
47
|
+
},
|
|
48
|
+
{
|
|
49
|
+
name: 'effect',
|
|
50
|
+
type: 'radio',
|
|
51
|
+
options: [
|
|
52
|
+
{
|
|
53
|
+
label: 'Allow',
|
|
54
|
+
value: 'allow'
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
label: 'Deny',
|
|
58
|
+
value: 'deny'
|
|
59
|
+
}
|
|
60
|
+
],
|
|
61
|
+
required: true
|
|
62
|
+
}
|
|
63
|
+
],
|
|
64
|
+
hooks: {
|
|
65
|
+
afterChange: [
|
|
66
|
+
async ({ context, doc, operation, previousDoc, req })=>{
|
|
67
|
+
if (context[PART_OF_CHANGE]) {
|
|
68
|
+
return;
|
|
69
|
+
}
|
|
70
|
+
await writeAudit(req, {
|
|
71
|
+
action: operation === 'create' ? 'override.add' : 'override.change',
|
|
72
|
+
after: snapshot(doc),
|
|
73
|
+
before: operation === 'create' ? null : snapshot(previousDoc),
|
|
74
|
+
summary: `Override: ${doc.effect} ${doc.permission}`,
|
|
75
|
+
user: relationID(doc.user)
|
|
76
|
+
});
|
|
77
|
+
}
|
|
78
|
+
],
|
|
79
|
+
afterDelete: [
|
|
80
|
+
async ({ context, doc, req })=>{
|
|
81
|
+
if (context[PART_OF_CHANGE]) {
|
|
82
|
+
return;
|
|
83
|
+
}
|
|
84
|
+
await writeAudit(req, {
|
|
85
|
+
action: 'override.remove',
|
|
86
|
+
before: snapshot(doc),
|
|
87
|
+
summary: `Override removed: ${doc.effect} ${doc.permission}`,
|
|
88
|
+
user: relationID(doc.user)
|
|
89
|
+
});
|
|
90
|
+
}
|
|
91
|
+
],
|
|
92
|
+
beforeChange: [
|
|
93
|
+
async ({ data, originalDoc, req })=>{
|
|
94
|
+
const next = {
|
|
95
|
+
...originalDoc,
|
|
96
|
+
...data
|
|
97
|
+
};
|
|
98
|
+
assertNotSelf(req, relationID(next.user));
|
|
99
|
+
if (originalDoc) {
|
|
100
|
+
assertNotSelf(req, relationID(originalDoc.user));
|
|
101
|
+
}
|
|
102
|
+
// Lifting a deny can hand the permission back, which counts as granting it.
|
|
103
|
+
if (originalDoc?.effect === 'deny') {
|
|
104
|
+
await assertCanGrant(req, [
|
|
105
|
+
originalDoc.permission
|
|
106
|
+
]);
|
|
107
|
+
}
|
|
108
|
+
if (next.effect === 'allow') {
|
|
109
|
+
await assertCanGrant(req, [
|
|
110
|
+
next.permission
|
|
111
|
+
]);
|
|
112
|
+
}
|
|
113
|
+
return data;
|
|
114
|
+
}
|
|
115
|
+
],
|
|
116
|
+
beforeDelete: [
|
|
117
|
+
async ({ id, context, req })=>{
|
|
118
|
+
if (context[PART_OF_CHANGE]) {
|
|
119
|
+
return;
|
|
120
|
+
}
|
|
121
|
+
const doc = await req.payload.findByID({
|
|
122
|
+
id,
|
|
123
|
+
collection: OVERRIDES_SLUG,
|
|
124
|
+
depth: 0,
|
|
125
|
+
overrideAccess: true,
|
|
126
|
+
req
|
|
127
|
+
});
|
|
128
|
+
assertNotSelf(req, relationID(doc.user));
|
|
129
|
+
if (doc.effect === 'deny') {
|
|
130
|
+
await assertCanGrant(req, [
|
|
131
|
+
doc.permission
|
|
132
|
+
]);
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
]
|
|
136
|
+
},
|
|
137
|
+
indexes: [
|
|
138
|
+
{
|
|
139
|
+
fields: [
|
|
140
|
+
'user',
|
|
141
|
+
'permission'
|
|
142
|
+
],
|
|
143
|
+
unique: true
|
|
144
|
+
}
|
|
145
|
+
],
|
|
146
|
+
labels: {
|
|
147
|
+
plural: 'Permission overrides',
|
|
148
|
+
singular: 'Permission override'
|
|
149
|
+
}
|
|
150
|
+
});
|
|
151
|
+
|
|
152
|
+
//# sourceMappingURL=PermissionOverrides.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/collections/PermissionOverrides.ts"],"sourcesContent":["import type { CollectionConfig, CollectionSlug } from 'payload'\n\nimport type { Area } from '../types.js'\n\nimport {\n hasPermission,\n isCMSUser,\n OVERRIDES_SLUG,\n relationID,\n requirePermission,\n} from '../access.js'\nimport { PART_OF_CHANGE, writeAudit } from '../audit.js'\nimport { MANAGE_PERMISSION } from '../registry.js'\nimport { assertCanGrant, assertNotSelf } from '../rules.js'\n\ntype OverrideDoc = {\n effect: 'allow' | 'deny'\n id: number | string\n permission: string\n user: unknown\n}\n\nconst snapshot = (doc: OverrideDoc) => ({ effect: doc.effect, permission: doc.permission })\n\nexport const createOverridesCollection = ({\n registry,\n usersSlug,\n}: {\n registry: Area[]\n usersSlug: CollectionSlug\n}): CollectionConfig => ({\n slug: OVERRIDES_SLUG,\n access: {\n create: requirePermission(MANAGE_PERMISSION),\n delete: requirePermission(MANAGE_PERMISSION),\n // Managers see every override; other CMS users only their own.\n read: async ({ req }) => {\n if (await hasPermission(req, MANAGE_PERMISSION)) {\n return true\n }\n return isCMSUser(req.payload, req.user) ? { user: { equals: req.user.id } } : false\n },\n update: requirePermission(MANAGE_PERMISSION),\n },\n admin: {\n // Edited through the user panel.\n hidden: true,\n },\n fields: [\n { name: 'user', type: 'relationship', index: true, relationTo: usersSlug, required: true },\n {\n name: 'permission',\n type: 'select',\n options: registry.flatMap((area) =>\n area.permissions.map((p) => ({ label: `${area.label} · ${p.label}`, value: p.key })),\n ),\n required: true,\n },\n {\n name: 'effect',\n type: 'radio',\n options: [\n { label: 'Allow', value: 'allow' },\n { label: 'Deny', value: 'deny' },\n ],\n required: true,\n },\n ],\n hooks: {\n afterChange: [\n async ({ context, doc, operation, previousDoc, req }) => {\n if (context[PART_OF_CHANGE]) {\n return\n }\n await writeAudit(req, {\n action: operation === 'create' ? 'override.add' : 'override.change',\n after: snapshot(doc),\n before: operation === 'create' ? null : snapshot(previousDoc),\n summary: `Override: ${doc.effect} ${doc.permission}`,\n user: relationID(doc.user),\n })\n },\n ],\n afterDelete: [\n async ({ context, doc, req }) => {\n if (context[PART_OF_CHANGE]) {\n return\n }\n await writeAudit(req, {\n action: 'override.remove',\n before: snapshot(doc),\n summary: `Override removed: ${doc.effect} ${doc.permission}`,\n user: relationID(doc.user),\n })\n },\n ],\n beforeChange: [\n async ({ data, originalDoc, req }) => {\n const next = { ...originalDoc, ...data } as OverrideDoc\n assertNotSelf(req, relationID(next.user))\n if (originalDoc) {\n assertNotSelf(req, relationID(originalDoc.user))\n }\n // Lifting a deny can hand the permission back, which counts as granting it.\n if (originalDoc?.effect === 'deny') {\n await assertCanGrant(req, [originalDoc.permission])\n }\n if (next.effect === 'allow') {\n await assertCanGrant(req, [next.permission])\n }\n return data\n },\n ],\n beforeDelete: [\n async ({ id, context, req }) => {\n if (context[PART_OF_CHANGE]) {\n return\n }\n const doc = await req.payload.findByID({\n id,\n collection: OVERRIDES_SLUG,\n depth: 0,\n overrideAccess: true,\n req,\n })\n assertNotSelf(req, relationID(doc.user))\n if (doc.effect === 'deny') {\n await assertCanGrant(req, [doc.permission])\n }\n },\n ],\n },\n indexes: [{ fields: ['user', 'permission'], unique: true }],\n labels: { plural: 'Permission overrides', singular: 'Permission override' },\n})\n"],"names":["hasPermission","isCMSUser","OVERRIDES_SLUG","relationID","requirePermission","PART_OF_CHANGE","writeAudit","MANAGE_PERMISSION","assertCanGrant","assertNotSelf","snapshot","doc","effect","permission","createOverridesCollection","registry","usersSlug","slug","access","create","delete","read","req","payload","user","equals","id","update","admin","hidden","fields","name","type","index","relationTo","required","options","flatMap","area","permissions","map","p","label","value","key","hooks","afterChange","context","operation","previousDoc","action","after","before","summary","afterDelete","beforeChange","data","originalDoc","next","beforeDelete","findByID","collection","depth","overrideAccess","indexes","unique","labels","plural","singular"],"mappings":"AAIA,SACEA,aAAa,EACbC,SAAS,EACTC,cAAc,EACdC,UAAU,EACVC,iBAAiB,QACZ,eAAc;AACrB,SAASC,cAAc,EAAEC,UAAU,QAAQ,cAAa;AACxD,SAASC,iBAAiB,QAAQ,iBAAgB;AAClD,SAASC,cAAc,EAAEC,aAAa,QAAQ,cAAa;AAS3D,MAAMC,WAAW,CAACC,MAAsB,CAAA;QAAEC,QAAQD,IAAIC,MAAM;QAAEC,YAAYF,IAAIE,UAAU;IAAC,CAAA;AAEzF,OAAO,MAAMC,4BAA4B,CAAC,EACxCC,QAAQ,EACRC,SAAS,EAIV,GAAwB,CAAA;QACvBC,MAAMf;QACNgB,QAAQ;YACNC,QAAQf,kBAAkBG;YAC1Ba,QAAQhB,kBAAkBG;YAC1B,+DAA+D;YAC/Dc,MAAM,OAAO,EAAEC,GAAG,EAAE;gBAClB,IAAI,MAAMtB,cAAcsB,KAAKf,oBAAoB;oBAC/C,OAAO;gBACT;gBACA,OAAON,UAAUqB,IAAIC,OAAO,EAAED,IAAIE,IAAI,IAAI;oBAAEA,MAAM;wBAAEC,QAAQH,IAAIE,IAAI,CAACE,EAAE;oBAAC;gBAAE,IAAI;YAChF;YACAC,QAAQvB,kBAAkBG;QAC5B;QACAqB,OAAO;YACL,iCAAiC;YACjCC,QAAQ;QACV;QACAC,QAAQ;YACN;gBAAEC,MAAM;gBAAQC,MAAM;gBAAgBC,OAAO;gBAAMC,YAAYlB;gBAAWmB,UAAU;YAAK;YACzF;gBACEJ,MAAM;gBACNC,MAAM;gBACNI,SAASrB,SAASsB,OAAO,CAAC,CAACC,OACzBA,KAAKC,WAAW,CAACC,GAAG,CAAC,CAACC,IAAO,CAAA;4BAAEC,OAAO,GAAGJ,KAAKI,KAAK,CAAC,GAAG,EAAED,EAAEC,KAAK,EAAE;4BAAEC,OAAOF,EAAEG,GAAG;wBAAC,CAAA;gBAEnFT,UAAU;YACZ;YACA;gBACEJ,MAAM;gBACNC,MAAM;gBACNI,SAAS;oBACP;wBAAEM,OAAO;wBAASC,OAAO;oBAAQ;oBACjC;wBAAED,OAAO;wBAAQC,OAAO;oBAAO;iBAChC;gBACDR,UAAU;YACZ;SACD;QACDU,OAAO;YACLC,aAAa;gBACX,OAAO,EAAEC,OAAO,EAAEpC,GAAG,EAAEqC,SAAS,EAAEC,WAAW,EAAE3B,GAAG,EAAE;oBAClD,IAAIyB,OAAO,CAAC1C,eAAe,EAAE;wBAC3B;oBACF;oBACA,MAAMC,WAAWgB,KAAK;wBACpB4B,QAAQF,cAAc,WAAW,iBAAiB;wBAClDG,OAAOzC,SAASC;wBAChByC,QAAQJ,cAAc,WAAW,OAAOtC,SAASuC;wBACjDI,SAAS,CAAC,UAAU,EAAE1C,IAAIC,MAAM,CAAC,CAAC,EAAED,IAAIE,UAAU,EAAE;wBACpDW,MAAMrB,WAAWQ,IAAIa,IAAI;oBAC3B;gBACF;aACD;YACD8B,aAAa;gBACX,OAAO,EAAEP,OAAO,EAAEpC,GAAG,EAAEW,GAAG,EAAE;oBAC1B,IAAIyB,OAAO,CAAC1C,eAAe,EAAE;wBAC3B;oBACF;oBACA,MAAMC,WAAWgB,KAAK;wBACpB4B,QAAQ;wBACRE,QAAQ1C,SAASC;wBACjB0C,SAAS,CAAC,kBAAkB,EAAE1C,IAAIC,MAAM,CAAC,CAAC,EAAED,IAAIE,UAAU,EAAE;wBAC5DW,MAAMrB,WAAWQ,IAAIa,IAAI;oBAC3B;gBACF;aACD;YACD+B,cAAc;gBACZ,OAAO,EAAEC,IAAI,EAAEC,WAAW,EAAEnC,GAAG,EAAE;oBAC/B,MAAMoC,OAAO;wBAAE,GAAGD,WAAW;wBAAE,GAAGD,IAAI;oBAAC;oBACvC/C,cAAca,KAAKnB,WAAWuD,KAAKlC,IAAI;oBACvC,IAAIiC,aAAa;wBACfhD,cAAca,KAAKnB,WAAWsD,YAAYjC,IAAI;oBAChD;oBACA,4EAA4E;oBAC5E,IAAIiC,aAAa7C,WAAW,QAAQ;wBAClC,MAAMJ,eAAec,KAAK;4BAACmC,YAAY5C,UAAU;yBAAC;oBACpD;oBACA,IAAI6C,KAAK9C,MAAM,KAAK,SAAS;wBAC3B,MAAMJ,eAAec,KAAK;4BAACoC,KAAK7C,UAAU;yBAAC;oBAC7C;oBACA,OAAO2C;gBACT;aACD;YACDG,cAAc;gBACZ,OAAO,EAAEjC,EAAE,EAAEqB,OAAO,EAAEzB,GAAG,EAAE;oBACzB,IAAIyB,OAAO,CAAC1C,eAAe,EAAE;wBAC3B;oBACF;oBACA,MAAMM,MAAM,MAAMW,IAAIC,OAAO,CAACqC,QAAQ,CAAC;wBACrClC;wBACAmC,YAAY3D;wBACZ4D,OAAO;wBACPC,gBAAgB;wBAChBzC;oBACF;oBACAb,cAAca,KAAKnB,WAAWQ,IAAIa,IAAI;oBACtC,IAAIb,IAAIC,MAAM,KAAK,QAAQ;wBACzB,MAAMJ,eAAec,KAAK;4BAACX,IAAIE,UAAU;yBAAC;oBAC5C;gBACF;aACD;QACH;QACAmD,SAAS;YAAC;gBAAElC,QAAQ;oBAAC;oBAAQ;iBAAa;gBAAEmC,QAAQ;YAAK;SAAE;QAC3DC,QAAQ;YAAEC,QAAQ;YAAwBC,UAAU;QAAsB;IAC5E,CAAA,EAAE"}
|