@directus/api 19.3.0 → 20.0.0-rc.0

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.
Files changed (287) hide show
  1. package/dist/app.js +4 -4
  2. package/dist/auth/drivers/ldap.js +4 -4
  3. package/dist/auth/drivers/local.js +4 -4
  4. package/dist/auth/drivers/oauth2.js +4 -4
  5. package/dist/auth/drivers/openid.js +2 -4
  6. package/dist/cache.js +3 -0
  7. package/dist/cli/commands/bootstrap/index.js +8 -2
  8. package/dist/cli/commands/init/index.js +9 -10
  9. package/dist/cli/utils/defaults.d.ts +4 -11
  10. package/dist/cli/utils/defaults.js +7 -1
  11. package/dist/constants.d.ts +1 -1
  12. package/dist/controllers/access.d.ts +2 -0
  13. package/dist/controllers/access.js +148 -0
  14. package/dist/controllers/auth.js +5 -16
  15. package/dist/controllers/permissions.js +14 -2
  16. package/dist/controllers/policies.d.ts +2 -0
  17. package/dist/controllers/policies.js +169 -0
  18. package/dist/controllers/roles.js +22 -1
  19. package/dist/controllers/users.js +0 -55
  20. package/dist/database/errors/dialects/mysql.js +23 -23
  21. package/dist/database/get-ast-from-query/get-ast-from-query.d.ts +16 -0
  22. package/dist/database/get-ast-from-query/get-ast-from-query.js +82 -0
  23. package/dist/database/get-ast-from-query/lib/convert-wildcards.d.ts +13 -0
  24. package/dist/database/get-ast-from-query/lib/convert-wildcards.js +69 -0
  25. package/dist/database/get-ast-from-query/lib/parse-fields.d.ts +15 -0
  26. package/dist/database/get-ast-from-query/lib/parse-fields.js +190 -0
  27. package/dist/database/get-ast-from-query/utils/get-deep-query.d.ts +14 -0
  28. package/dist/database/get-ast-from-query/utils/get-deep-query.js +17 -0
  29. package/dist/database/get-ast-from-query/utils/get-related-collection.d.ts +2 -0
  30. package/dist/database/get-ast-from-query/utils/get-related-collection.js +13 -0
  31. package/dist/database/get-ast-from-query/utils/get-relation.d.ts +2 -0
  32. package/dist/database/get-ast-from-query/utils/get-relation.js +7 -0
  33. package/dist/database/helpers/fn/types.d.ts +2 -1
  34. package/dist/database/helpers/fn/types.js +1 -1
  35. package/dist/database/helpers/geometry/dialects/mssql.d.ts +1 -1
  36. package/dist/database/helpers/geometry/dialects/mssql.js +4 -2
  37. package/dist/database/helpers/geometry/dialects/mysql.js +1 -1
  38. package/dist/database/helpers/geometry/dialects/oracle.d.ts +1 -1
  39. package/dist/database/helpers/geometry/dialects/oracle.js +5 -3
  40. package/dist/database/helpers/geometry/types.d.ts +1 -1
  41. package/dist/database/helpers/geometry/types.js +4 -2
  42. package/dist/database/index.js +2 -1
  43. package/dist/database/migrations/20240619A-permissions-policies.d.ts +3 -0
  44. package/dist/database/migrations/20240619A-permissions-policies.js +163 -0
  45. package/dist/database/run-ast/lib/get-db-query.d.ts +4 -0
  46. package/dist/database/run-ast/lib/get-db-query.js +194 -0
  47. package/dist/database/run-ast/lib/parse-current-level.d.ts +7 -0
  48. package/dist/database/run-ast/lib/parse-current-level.js +41 -0
  49. package/dist/database/run-ast/run-ast.d.ts +7 -0
  50. package/dist/database/run-ast/run-ast.js +107 -0
  51. package/dist/database/{run-ast.d.ts → run-ast/types.d.ts} +3 -9
  52. package/dist/database/run-ast/types.js +1 -0
  53. package/dist/database/run-ast/utils/apply-case-when.d.ts +16 -0
  54. package/dist/database/run-ast/utils/apply-case-when.js +26 -0
  55. package/dist/database/run-ast/utils/apply-parent-filters.d.ts +3 -0
  56. package/dist/database/run-ast/utils/apply-parent-filters.js +55 -0
  57. package/dist/database/run-ast/utils/get-column-pre-processor.d.ts +10 -0
  58. package/dist/database/run-ast/utils/get-column-pre-processor.js +57 -0
  59. package/dist/database/run-ast/utils/get-field-alias.d.ts +2 -0
  60. package/dist/database/run-ast/utils/get-field-alias.js +4 -0
  61. package/dist/database/run-ast/utils/get-inner-query-column-pre-processor.d.ts +5 -0
  62. package/dist/database/run-ast/utils/get-inner-query-column-pre-processor.js +23 -0
  63. package/dist/database/run-ast/utils/merge-with-parent-items.d.ts +3 -0
  64. package/dist/database/run-ast/utils/merge-with-parent-items.js +87 -0
  65. package/dist/database/run-ast/utils/remove-temporary-fields.d.ts +3 -0
  66. package/dist/database/run-ast/utils/remove-temporary-fields.js +73 -0
  67. package/dist/extensions/lib/sandbox/generate-api-extensions-sandbox-entrypoint.d.ts +1 -1
  68. package/dist/flows.js +3 -4
  69. package/dist/middleware/authenticate.js +2 -7
  70. package/dist/middleware/cache.js +1 -1
  71. package/dist/middleware/cors.js +4 -4
  72. package/dist/middleware/respond.js +1 -1
  73. package/dist/permissions/cache.d.ts +2 -0
  74. package/dist/permissions/cache.js +23 -0
  75. package/dist/permissions/lib/fetch-permissions.d.ts +10 -0
  76. package/dist/permissions/lib/fetch-permissions.js +55 -0
  77. package/dist/permissions/lib/fetch-policies.d.ts +7 -0
  78. package/dist/permissions/lib/fetch-policies.js +28 -0
  79. package/dist/permissions/lib/fetch-roles-tree.d.ts +3 -0
  80. package/dist/permissions/lib/fetch-roles-tree.js +28 -0
  81. package/dist/{services/permissions → permissions}/lib/with-app-minimal-permissions.d.ts +1 -1
  82. package/dist/permissions/lib/with-app-minimal-permissions.js +10 -0
  83. package/dist/permissions/modules/fetch-accountability-collection-access/fetch-accountability-collection-access.d.ts +7 -0
  84. package/dist/permissions/modules/fetch-accountability-collection-access/fetch-accountability-collection-access.js +56 -0
  85. package/dist/permissions/modules/fetch-accountability-policy-globals/fetch-accountability-policy-globals.d.ts +3 -0
  86. package/dist/permissions/modules/fetch-accountability-policy-globals/fetch-accountability-policy-globals.js +16 -0
  87. package/dist/permissions/modules/fetch-allowed-collections/fetch-allowed-collections.d.ts +8 -0
  88. package/dist/permissions/modules/fetch-allowed-collections/fetch-allowed-collections.js +24 -0
  89. package/dist/permissions/modules/fetch-allowed-field-map/fetch-allowed-field-map.d.ts +9 -0
  90. package/dist/permissions/modules/fetch-allowed-field-map/fetch-allowed-field-map.js +31 -0
  91. package/dist/permissions/modules/fetch-allowed-fields/fetch-allowed-fields.d.ts +16 -0
  92. package/dist/permissions/modules/fetch-allowed-fields/fetch-allowed-fields.js +27 -0
  93. package/dist/permissions/modules/fetch-global-access/fetch-global-access.d.ts +10 -0
  94. package/dist/permissions/modules/fetch-global-access/fetch-global-access.js +23 -0
  95. package/dist/permissions/modules/fetch-global-access/lib/fetch-global-access-for-roles.d.ts +5 -0
  96. package/dist/permissions/modules/fetch-global-access/lib/fetch-global-access-for-roles.js +7 -0
  97. package/dist/permissions/modules/fetch-global-access/lib/fetch-global-access-for-user.d.ts +5 -0
  98. package/dist/permissions/modules/fetch-global-access/lib/fetch-global-access-for-user.js +10 -0
  99. package/dist/permissions/modules/fetch-global-access/types.d.ts +4 -0
  100. package/dist/permissions/modules/fetch-global-access/types.js +1 -0
  101. package/dist/permissions/modules/fetch-global-access/utils/fetch-global-access-for-query.d.ts +4 -0
  102. package/dist/permissions/modules/fetch-global-access/utils/fetch-global-access-for-query.js +27 -0
  103. package/dist/permissions/modules/fetch-inconsistent-field-map/fetch-inconsistent-field-map.d.ts +12 -0
  104. package/dist/permissions/modules/fetch-inconsistent-field-map/fetch-inconsistent-field-map.js +32 -0
  105. package/dist/permissions/modules/fetch-policies-ip-access/fetch-policies-ip-access.d.ts +4 -0
  106. package/dist/permissions/modules/fetch-policies-ip-access/fetch-policies-ip-access.js +29 -0
  107. package/dist/permissions/modules/process-ast/lib/extract-fields-from-children.d.ts +4 -0
  108. package/dist/permissions/modules/process-ast/lib/extract-fields-from-children.js +49 -0
  109. package/dist/permissions/modules/process-ast/lib/extract-fields-from-query.d.ts +3 -0
  110. package/dist/permissions/modules/process-ast/lib/extract-fields-from-query.js +56 -0
  111. package/dist/permissions/modules/process-ast/lib/field-map-from-ast.d.ts +4 -0
  112. package/dist/permissions/modules/process-ast/lib/field-map-from-ast.js +8 -0
  113. package/dist/permissions/modules/process-ast/lib/inject-cases.d.ts +9 -0
  114. package/dist/permissions/modules/process-ast/lib/inject-cases.js +93 -0
  115. package/dist/permissions/modules/process-ast/process-ast.d.ts +9 -0
  116. package/dist/permissions/modules/process-ast/process-ast.js +39 -0
  117. package/dist/permissions/modules/process-ast/types.d.ts +24 -0
  118. package/dist/permissions/modules/process-ast/types.js +1 -0
  119. package/dist/permissions/modules/process-ast/utils/collections-in-field-map.d.ts +2 -0
  120. package/dist/permissions/modules/process-ast/utils/collections-in-field-map.js +7 -0
  121. package/dist/permissions/modules/process-ast/utils/dedupe-access.d.ts +12 -0
  122. package/dist/permissions/modules/process-ast/utils/dedupe-access.js +30 -0
  123. package/dist/permissions/modules/process-ast/utils/extract-paths-from-query.d.ts +15 -0
  124. package/dist/permissions/modules/process-ast/utils/extract-paths-from-query.js +50 -0
  125. package/dist/permissions/modules/process-ast/utils/find-related-collection.d.ts +3 -0
  126. package/dist/permissions/modules/process-ast/utils/find-related-collection.js +9 -0
  127. package/dist/permissions/modules/process-ast/utils/flatten-filter.d.ts +3 -0
  128. package/dist/permissions/modules/process-ast/utils/flatten-filter.js +24 -0
  129. package/dist/permissions/modules/process-ast/utils/format-a2o-key.d.ts +1 -0
  130. package/dist/permissions/modules/process-ast/utils/format-a2o-key.js +3 -0
  131. package/dist/permissions/modules/process-ast/utils/get-info-for-path.d.ts +5 -0
  132. package/dist/permissions/modules/process-ast/utils/get-info-for-path.js +7 -0
  133. package/dist/permissions/modules/process-ast/utils/has-item-permissions.d.ts +2 -0
  134. package/dist/permissions/modules/process-ast/utils/has-item-permissions.js +3 -0
  135. package/dist/permissions/modules/process-ast/utils/stringify-query-path.d.ts +2 -0
  136. package/dist/permissions/modules/process-ast/utils/stringify-query-path.js +3 -0
  137. package/dist/permissions/modules/process-ast/utils/validate-path/create-error.d.ts +3 -0
  138. package/dist/permissions/modules/process-ast/utils/validate-path/create-error.js +16 -0
  139. package/dist/permissions/modules/process-ast/utils/validate-path/validate-path-existence.d.ts +2 -0
  140. package/dist/permissions/modules/process-ast/utils/validate-path/validate-path-existence.js +12 -0
  141. package/dist/permissions/modules/process-ast/utils/validate-path/validate-path-permissions.d.ts +2 -0
  142. package/dist/permissions/modules/process-ast/utils/validate-path/validate-path-permissions.js +28 -0
  143. package/dist/permissions/modules/process-payload/lib/is-field-nullable.d.ts +5 -0
  144. package/dist/permissions/modules/process-payload/lib/is-field-nullable.js +12 -0
  145. package/dist/permissions/modules/process-payload/process-payload.d.ts +13 -0
  146. package/dist/permissions/modules/process-payload/process-payload.js +77 -0
  147. package/dist/permissions/modules/validate-access/lib/validate-collection-access.d.ts +12 -0
  148. package/dist/permissions/modules/validate-access/lib/validate-collection-access.js +11 -0
  149. package/dist/permissions/modules/validate-access/lib/validate-item-access.d.ts +9 -0
  150. package/dist/permissions/modules/validate-access/lib/validate-item-access.js +33 -0
  151. package/dist/permissions/modules/validate-access/validate-access.d.ts +14 -0
  152. package/dist/permissions/modules/validate-access/validate-access.js +28 -0
  153. package/dist/permissions/modules/validate-remaining-admin/validate-remaining-admin-count.d.ts +1 -0
  154. package/dist/permissions/modules/validate-remaining-admin/validate-remaining-admin-count.js +8 -0
  155. package/dist/permissions/modules/validate-remaining-admin/validate-remaining-admin-users.d.ts +5 -0
  156. package/dist/permissions/modules/validate-remaining-admin/validate-remaining-admin-users.js +10 -0
  157. package/dist/permissions/types.d.ts +6 -0
  158. package/dist/permissions/types.js +1 -0
  159. package/dist/permissions/utils/create-default-accountability.d.ts +2 -0
  160. package/dist/permissions/utils/create-default-accountability.js +11 -0
  161. package/dist/permissions/utils/extract-required-dynamic-variable-context.d.ts +8 -0
  162. package/dist/permissions/utils/extract-required-dynamic-variable-context.js +27 -0
  163. package/dist/permissions/utils/fetch-dynamic-variable-context.d.ts +9 -0
  164. package/dist/permissions/utils/fetch-dynamic-variable-context.js +43 -0
  165. package/dist/permissions/utils/filter-policies-by-ip.d.ts +2 -0
  166. package/dist/permissions/utils/filter-policies-by-ip.js +15 -0
  167. package/dist/permissions/utils/get-unaliased-field-key.d.ts +5 -0
  168. package/dist/permissions/utils/get-unaliased-field-key.js +17 -0
  169. package/dist/permissions/utils/process-permissions.d.ts +7 -0
  170. package/dist/permissions/utils/process-permissions.js +9 -0
  171. package/dist/permissions/utils/with-cache.d.ts +10 -0
  172. package/dist/permissions/utils/with-cache.js +25 -0
  173. package/dist/services/access.d.ts +10 -0
  174. package/dist/services/access.js +43 -0
  175. package/dist/services/activity.js +22 -10
  176. package/dist/services/assets.d.ts +2 -3
  177. package/dist/services/assets.js +10 -5
  178. package/dist/services/authentication.js +18 -18
  179. package/dist/services/collections.js +18 -17
  180. package/dist/services/fields.d.ts +0 -1
  181. package/dist/services/fields.js +53 -24
  182. package/dist/services/files.d.ts +0 -4
  183. package/dist/services/files.js +10 -10
  184. package/dist/services/flows.d.ts +0 -2
  185. package/dist/services/flows.js +2 -14
  186. package/dist/services/graphql/index.d.ts +3 -3
  187. package/dist/services/graphql/index.js +126 -22
  188. package/dist/services/graphql/subscription.js +2 -4
  189. package/dist/services/import-export.js +23 -9
  190. package/dist/services/index.d.ts +3 -2
  191. package/dist/services/index.js +3 -2
  192. package/dist/services/items.d.ts +40 -14
  193. package/dist/services/items.js +182 -79
  194. package/dist/services/meta.js +60 -23
  195. package/dist/services/notifications.d.ts +0 -1
  196. package/dist/services/notifications.js +0 -7
  197. package/dist/services/operations.d.ts +0 -2
  198. package/dist/services/operations.js +2 -14
  199. package/dist/services/payload.d.ts +9 -10
  200. package/dist/services/payload.js +35 -19
  201. package/dist/services/{permissions/index.d.ts → permissions.d.ts} +5 -7
  202. package/dist/services/{permissions/index.js → permissions.js} +30 -54
  203. package/dist/services/policies.d.ts +12 -0
  204. package/dist/services/policies.js +87 -0
  205. package/dist/services/relations.d.ts +0 -6
  206. package/dist/services/relations.js +26 -29
  207. package/dist/services/roles.d.ts +4 -14
  208. package/dist/services/roles.js +56 -420
  209. package/dist/services/shares.d.ts +0 -2
  210. package/dist/services/shares.js +12 -8
  211. package/dist/services/specifications.d.ts +2 -2
  212. package/dist/services/specifications.js +39 -27
  213. package/dist/services/users.d.ts +2 -20
  214. package/dist/services/users.js +87 -190
  215. package/dist/services/utils.js +11 -7
  216. package/dist/services/versions.d.ts +0 -2
  217. package/dist/services/versions.js +34 -10
  218. package/dist/telemetry/lib/get-report.js +6 -3
  219. package/dist/telemetry/types/report.d.ts +4 -0
  220. package/dist/telemetry/utils/check-user-limits.d.ts +5 -0
  221. package/dist/telemetry/utils/check-user-limits.js +19 -0
  222. package/dist/telemetry/utils/get-filesize-sum.d.ts +5 -0
  223. package/dist/telemetry/utils/get-filesize-sum.js +7 -0
  224. package/dist/telemetry/utils/should-check-user-limits.d.ts +4 -0
  225. package/dist/telemetry/utils/should-check-user-limits.js +13 -0
  226. package/dist/types/ast.d.ts +43 -1
  227. package/dist/types/items.d.ts +11 -0
  228. package/dist/utils/apply-query.d.ts +4 -3
  229. package/dist/utils/apply-query.js +37 -8
  230. package/dist/utils/fetch-user-count/fetch-access-lookup.d.ts +17 -0
  231. package/dist/utils/fetch-user-count/fetch-access-lookup.js +22 -0
  232. package/dist/utils/fetch-user-count/fetch-access-roles.d.ts +16 -0
  233. package/dist/utils/fetch-user-count/fetch-access-roles.js +37 -0
  234. package/dist/utils/fetch-user-count/fetch-active-users.d.ts +6 -0
  235. package/dist/utils/fetch-user-count/fetch-active-users.js +3 -0
  236. package/dist/utils/fetch-user-count/fetch-user-count.d.ts +12 -0
  237. package/dist/utils/fetch-user-count/fetch-user-count.js +57 -0
  238. package/dist/utils/fetch-user-count/get-user-count-query.d.ts +20 -0
  239. package/dist/utils/fetch-user-count/get-user-count-query.js +17 -0
  240. package/dist/utils/get-accountability-for-role.js +16 -25
  241. package/dist/utils/get-accountability-for-token.js +17 -16
  242. package/dist/utils/get-cache-key.d.ts +1 -1
  243. package/dist/utils/get-cache-key.js +12 -1
  244. package/dist/utils/get-column.d.ts +2 -1
  245. package/dist/utils/get-column.js +1 -0
  246. package/dist/utils/get-graphql-type.js +1 -0
  247. package/dist/utils/get-service.d.ts +1 -1
  248. package/dist/utils/get-service.js +14 -10
  249. package/dist/utils/reduce-schema.d.ts +4 -6
  250. package/dist/utils/reduce-schema.js +14 -34
  251. package/dist/utils/validate-user-count-integrity.d.ts +13 -0
  252. package/dist/utils/validate-user-count-integrity.js +29 -0
  253. package/dist/websocket/authenticate.d.ts +0 -2
  254. package/dist/websocket/authenticate.js +0 -12
  255. package/dist/websocket/controllers/graphql.js +1 -4
  256. package/dist/websocket/controllers/hooks.js +4 -0
  257. package/dist/websocket/controllers/rest.js +0 -2
  258. package/dist/websocket/handlers/subscribe.js +0 -2
  259. package/dist/websocket/utils/items.d.ts +1 -1
  260. package/dist/websocket/utils/items.js +4 -1
  261. package/package.json +36 -35
  262. package/dist/database/run-ast.js +0 -450
  263. package/dist/middleware/check-ip.d.ts +0 -2
  264. package/dist/middleware/check-ip.js +0 -37
  265. package/dist/middleware/get-permissions.d.ts +0 -3
  266. package/dist/middleware/get-permissions.js +0 -10
  267. package/dist/services/authorization.d.ts +0 -17
  268. package/dist/services/authorization.js +0 -456
  269. package/dist/services/permissions/lib/with-app-minimal-permissions.js +0 -13
  270. package/dist/telemetry/utils/check-increased-user-limits.d.ts +0 -7
  271. package/dist/telemetry/utils/check-increased-user-limits.js +0 -22
  272. package/dist/telemetry/utils/get-role-counts-by-roles.d.ts +0 -6
  273. package/dist/telemetry/utils/get-role-counts-by-roles.js +0 -27
  274. package/dist/telemetry/utils/get-role-counts-by-users.d.ts +0 -11
  275. package/dist/telemetry/utils/get-role-counts-by-users.js +0 -34
  276. package/dist/telemetry/utils/get-user-count.d.ts +0 -8
  277. package/dist/telemetry/utils/get-user-count.js +0 -33
  278. package/dist/telemetry/utils/get-user-counts-by-roles.d.ts +0 -7
  279. package/dist/telemetry/utils/get-user-counts-by-roles.js +0 -35
  280. package/dist/utils/get-ast-from-query.d.ts +0 -13
  281. package/dist/utils/get-ast-from-query.js +0 -297
  282. package/dist/utils/get-permissions.d.ts +0 -2
  283. package/dist/utils/get-permissions.js +0 -150
  284. package/dist/utils/merge-permissions-for-share.d.ts +0 -4
  285. package/dist/utils/merge-permissions-for-share.js +0 -109
  286. package/dist/utils/merge-permissions.d.ts +0 -3
  287. package/dist/utils/merge-permissions.js +0 -95
@@ -1,35 +0,0 @@
1
- import { toBoolean } from '@directus/utils';
2
- import {} from './get-user-count.js';
3
- /**
4
- * Get the user type counts by role IDs
5
- */
6
- export async function getUserCountsByRoles(db, roleIds) {
7
- const counts = {
8
- admin: 0,
9
- app: 0,
10
- api: 0,
11
- };
12
- const result = (await db
13
- .count('directus_users.id', { as: 'count' })
14
- .select('directus_roles.admin_access', 'directus_roles.app_access')
15
- .from('directus_users')
16
- .whereIn('directus_roles.id', roleIds)
17
- .andWhere('directus_users.status', '=', 'active')
18
- .leftJoin('directus_roles', 'directus_users.role', '=', 'directus_roles.id')
19
- .groupBy('directus_roles.admin_access', 'directus_roles.app_access'));
20
- for (const record of result) {
21
- const adminAccess = toBoolean(record.admin_access);
22
- const appAccess = toBoolean(record.app_access);
23
- const count = Number(record.count);
24
- if (adminAccess) {
25
- counts.admin += count;
26
- }
27
- else if (appAccess) {
28
- counts.app += count;
29
- }
30
- else {
31
- counts.api += count;
32
- }
33
- }
34
- return counts;
35
- }
@@ -1,13 +0,0 @@
1
- /**
2
- * Generate an AST based on a given collection and query
3
- */
4
- import type { Accountability, PermissionsAction, Query, SchemaOverview } from '@directus/types';
5
- import type { Knex } from 'knex';
6
- import type { AST } from '../types/index.js';
7
- type GetASTOptions = {
8
- accountability?: Accountability | null;
9
- action?: PermissionsAction;
10
- knex?: Knex;
11
- };
12
- export default function getASTFromQuery(collection: string, query: Query, schema: SchemaOverview, options?: GetASTOptions): Promise<AST>;
13
- export {};
@@ -1,297 +0,0 @@
1
- /**
2
- * Generate an AST based on a given collection and query
3
- */
4
- import { REGEX_BETWEEN_PARENS } from '@directus/constants';
5
- import { cloneDeep, isEmpty, mapKeys, omitBy, uniq } from 'lodash-es';
6
- import { getRelationType } from './get-relation-type.js';
7
- export default async function getASTFromQuery(collection, query, schema, options) {
8
- query = cloneDeep(query);
9
- const accountability = options?.accountability;
10
- const action = options?.action || 'read';
11
- const permissions = accountability && accountability.admin !== true
12
- ? accountability?.permissions?.filter((permission) => {
13
- return permission.action === action;
14
- }) ?? []
15
- : null;
16
- const ast = {
17
- type: 'root',
18
- name: collection,
19
- query: query,
20
- children: [],
21
- };
22
- let fields = ['*'];
23
- if (query.fields) {
24
- fields = query.fields;
25
- }
26
- /**
27
- * When using aggregate functions, you can't have any other regular fields
28
- * selected. This makes sure you never end up in a non-aggregate fields selection error
29
- */
30
- if (Object.keys(query.aggregate || {}).length > 0) {
31
- fields = [];
32
- }
33
- /**
34
- * Similarly, when grouping on a specific field, you can't have other non-aggregated fields.
35
- * The group query will override the fields query
36
- */
37
- if (query.group) {
38
- fields = query.group;
39
- }
40
- fields = uniq(fields);
41
- const deep = query.deep || {};
42
- // Prevent fields/deep from showing up in the query object in further use
43
- delete query.fields;
44
- delete query.deep;
45
- if (!query.sort) {
46
- // We'll default to the primary key for the standard sort output
47
- let sortField = schema.collections[collection].primary;
48
- // If a custom manual sort field is configured, use that
49
- if (schema.collections[collection]?.sortField) {
50
- sortField = schema.collections[collection].sortField;
51
- }
52
- // When group by is used, default to the first column provided in the group by clause
53
- if (query.group?.[0]) {
54
- sortField = query.group[0];
55
- }
56
- query.sort = [sortField];
57
- }
58
- // When no group by is supplied, but an aggregate function is used, only a single row will be
59
- // returned. In those cases, we'll ignore the sort field altogether
60
- if (query.aggregate && Object.keys(query.aggregate).length && !query.group?.[0]) {
61
- delete query.sort;
62
- }
63
- ast.children = await parseFields(collection, fields, deep);
64
- return ast;
65
- async function parseFields(parentCollection, fields, deep) {
66
- if (!fields)
67
- return [];
68
- fields = await convertWildcards(parentCollection, fields);
69
- if (!fields || !Array.isArray(fields))
70
- return [];
71
- const children = [];
72
- const relationalStructure = Object.create(null);
73
- for (const fieldKey of fields) {
74
- let name = fieldKey;
75
- if (query.alias) {
76
- // check for field alias (is one of the key)
77
- if (name in query.alias) {
78
- name = query.alias[fieldKey];
79
- }
80
- }
81
- const isRelational = name.includes('.') ||
82
- // We'll always treat top level o2m fields as a related item. This is an alias field, otherwise it won't return
83
- // anything
84
- !!schema.relations.find((relation) => relation.related_collection === parentCollection && relation.meta?.one_field === name);
85
- if (isRelational) {
86
- // field is relational
87
- const parts = fieldKey.split('.');
88
- let rootField = parts[0];
89
- let collectionScope = null;
90
- // a2o related collection scoped field selector `fields=sections.section_id:headings.title`
91
- if (rootField.includes(':')) {
92
- const [key, scope] = rootField.split(':');
93
- rootField = key;
94
- collectionScope = scope;
95
- }
96
- if (rootField in relationalStructure === false) {
97
- if (collectionScope) {
98
- relationalStructure[rootField] = { [collectionScope]: [] };
99
- }
100
- else {
101
- relationalStructure[rootField] = [];
102
- }
103
- }
104
- if (parts.length > 1) {
105
- const childKey = parts.slice(1).join('.');
106
- if (collectionScope) {
107
- if (collectionScope in relationalStructure[rootField] === false) {
108
- relationalStructure[rootField][collectionScope] = [];
109
- }
110
- relationalStructure[rootField][collectionScope].push(childKey);
111
- }
112
- else {
113
- relationalStructure[rootField].push(childKey);
114
- }
115
- }
116
- }
117
- else {
118
- if (fieldKey.includes('(') && fieldKey.includes(')')) {
119
- const columnName = fieldKey.match(REGEX_BETWEEN_PARENS)[1];
120
- const foundField = schema.collections[parentCollection].fields[columnName];
121
- if (foundField && foundField.type === 'alias') {
122
- const foundRelation = schema.relations.find((relation) => relation.related_collection === parentCollection && relation.meta?.one_field === columnName);
123
- if (foundRelation) {
124
- children.push({
125
- type: 'functionField',
126
- name,
127
- fieldKey,
128
- query: {},
129
- relatedCollection: foundRelation.collection,
130
- });
131
- continue;
132
- }
133
- }
134
- }
135
- children.push({ type: 'field', name, fieldKey });
136
- }
137
- }
138
- for (const [fieldKey, nestedFields] of Object.entries(relationalStructure)) {
139
- let fieldName = fieldKey;
140
- if (query.alias && fieldKey in query.alias) {
141
- fieldName = query.alias[fieldKey];
142
- }
143
- const relatedCollection = getRelatedCollection(parentCollection, fieldName);
144
- const relation = getRelation(parentCollection, fieldName);
145
- if (!relation)
146
- continue;
147
- const relationType = getRelationType({
148
- relation,
149
- collection: parentCollection,
150
- field: fieldName,
151
- });
152
- if (!relationType)
153
- continue;
154
- let child = null;
155
- if (relationType === 'a2o') {
156
- const allowedCollections = relation.meta.one_allowed_collections.filter((collection) => {
157
- if (!permissions)
158
- return true;
159
- return permissions.some((permission) => permission.collection === collection);
160
- });
161
- child = {
162
- type: 'a2o',
163
- names: allowedCollections,
164
- children: {},
165
- query: {},
166
- relatedKey: {},
167
- parentKey: schema.collections[parentCollection].primary,
168
- fieldKey: fieldKey,
169
- relation: relation,
170
- };
171
- for (const relatedCollection of allowedCollections) {
172
- child.children[relatedCollection] = await parseFields(relatedCollection, Array.isArray(nestedFields) ? nestedFields : nestedFields[relatedCollection] || [], deep?.[`${fieldKey}:${relatedCollection}`]);
173
- child.query[relatedCollection] = getDeepQuery(deep?.[`${fieldKey}:${relatedCollection}`] || {});
174
- child.relatedKey[relatedCollection] = schema.collections[relatedCollection].primary;
175
- }
176
- }
177
- else if (relatedCollection) {
178
- if (permissions && permissions.some((permission) => permission.collection === relatedCollection) === false) {
179
- continue;
180
- }
181
- // update query alias for children parseFields
182
- const deepAlias = getDeepQuery(deep?.[fieldKey] || {})?.['alias'];
183
- if (!isEmpty(deepAlias))
184
- query.alias = deepAlias;
185
- child = {
186
- type: relationType,
187
- name: relatedCollection,
188
- fieldKey: fieldKey,
189
- parentKey: schema.collections[parentCollection].primary,
190
- relatedKey: schema.collections[relatedCollection].primary,
191
- relation: relation,
192
- query: getDeepQuery(deep?.[fieldKey] || {}),
193
- children: await parseFields(relatedCollection, nestedFields, deep?.[fieldKey] || {}),
194
- };
195
- if (relationType === 'o2m' && !child.query.sort) {
196
- child.query.sort = [relation.meta?.sort_field || schema.collections[relation.collection].primary];
197
- }
198
- }
199
- if (child) {
200
- children.push(child);
201
- }
202
- }
203
- // Deduplicate any children fields that are included both as a regular field, and as a nested m2o field
204
- const nestedCollectionNodes = children.filter((childNode) => childNode.type !== 'field');
205
- return children.filter((childNode) => {
206
- const existsAsNestedRelational = !!nestedCollectionNodes.find((nestedCollectionNode) => childNode.fieldKey === nestedCollectionNode.fieldKey);
207
- if (childNode.type === 'field' && existsAsNestedRelational)
208
- return false;
209
- return true;
210
- });
211
- }
212
- async function convertWildcards(parentCollection, fields) {
213
- fields = cloneDeep(fields);
214
- const fieldsInCollection = Object.entries(schema.collections[parentCollection].fields).map(([name]) => name);
215
- let allowedFields = fieldsInCollection;
216
- if (permissions) {
217
- const permittedFields = permissions.find((permission) => parentCollection === permission.collection)?.fields;
218
- if (permittedFields !== undefined)
219
- allowedFields = permittedFields;
220
- }
221
- if (!allowedFields || allowedFields.length === 0)
222
- return [];
223
- // In case of full read permissions
224
- if (allowedFields[0] === '*')
225
- allowedFields = fieldsInCollection;
226
- for (let index = 0; index < fields.length; index++) {
227
- const fieldKey = fields[index];
228
- if (fieldKey.includes('*') === false)
229
- continue;
230
- if (fieldKey === '*') {
231
- const aliases = Object.keys(query.alias ?? {});
232
- // Set to all fields in collection
233
- if (allowedFields.includes('*')) {
234
- fields.splice(index, 1, ...fieldsInCollection, ...aliases);
235
- }
236
- else {
237
- // Set to all allowed fields
238
- const allowedAliases = aliases.filter((fieldKey) => {
239
- const name = query.alias[fieldKey];
240
- return allowedFields.includes(name);
241
- });
242
- fields.splice(index, 1, ...allowedFields, ...allowedAliases);
243
- }
244
- }
245
- // Swap *.* case for *,<relational-field>.*,<another-relational>.*
246
- if (fieldKey.includes('.') && fieldKey.split('.')[0] === '*') {
247
- const parts = fieldKey.split('.');
248
- const relationalFields = allowedFields.includes('*')
249
- ? schema.relations
250
- .filter((relation) => relation.collection === parentCollection || relation.related_collection === parentCollection)
251
- .map((relation) => {
252
- const isMany = relation.collection === parentCollection;
253
- return isMany ? relation.field : relation.meta?.one_field;
254
- })
255
- : allowedFields.filter((fieldKey) => !!getRelation(parentCollection, fieldKey));
256
- const nonRelationalFields = allowedFields.filter((fieldKey) => relationalFields.includes(fieldKey) === false);
257
- const aliasFields = Object.keys(query.alias ?? {}).map((fieldKey) => {
258
- const name = query.alias[fieldKey];
259
- if (relationalFields.includes(name)) {
260
- return `${fieldKey}.${parts.slice(1).join('.')}`;
261
- }
262
- return fieldKey;
263
- });
264
- fields.splice(index, 1, ...[
265
- ...relationalFields.map((relationalField) => {
266
- return `${relationalField}.${parts.slice(1).join('.')}`;
267
- }),
268
- ...nonRelationalFields,
269
- ...aliasFields,
270
- ]);
271
- }
272
- }
273
- return fields;
274
- }
275
- function getRelation(collection, field) {
276
- const relation = schema.relations.find((relation) => {
277
- return ((relation.collection === collection && relation.field === field) ||
278
- (relation.related_collection === collection && relation.meta?.one_field === field));
279
- });
280
- return relation;
281
- }
282
- function getRelatedCollection(collection, field) {
283
- const relation = getRelation(collection, field);
284
- if (!relation)
285
- return null;
286
- if (relation.collection === collection && relation.field === field) {
287
- return relation.related_collection || null;
288
- }
289
- if (relation.related_collection === collection && relation.meta?.one_field === field) {
290
- return relation.collection || null;
291
- }
292
- return null;
293
- }
294
- }
295
- function getDeepQuery(query) {
296
- return mapKeys(omitBy(query, (_value, key) => key.startsWith('_') === false), (_value, key) => key.substring(1));
297
- }
@@ -1,2 +0,0 @@
1
- import type { Accountability, Permission, SchemaOverview } from '@directus/types';
2
- export declare function getPermissions(accountability: Accountability, schema: SchemaOverview): Promise<Permission[]>;
@@ -1,150 +0,0 @@
1
- import { useEnv } from '@directus/env';
2
- import { deepMap, parseFilter, parseJSON, parsePreset } from '@directus/utils';
3
- import { cloneDeep } from 'lodash-es';
4
- import hash from 'object-hash';
5
- import { getCache, getCacheValue, getSystemCache, setCacheValue, setSystemCache } from '../cache.js';
6
- import getDatabase from '../database/index.js';
7
- import { appAccessMinimalPermissions } from '@directus/system-data';
8
- import { useLogger } from '../logger.js';
9
- import { RolesService } from '../services/roles.js';
10
- import { UsersService } from '../services/users.js';
11
- import { mergePermissionsForShare } from './merge-permissions-for-share.js';
12
- import { mergePermissions } from './merge-permissions.js';
13
- export async function getPermissions(accountability, schema) {
14
- const database = getDatabase();
15
- const { cache } = getCache();
16
- const env = useEnv();
17
- const logger = useLogger();
18
- let permissions = [];
19
- const { user, role, app, admin, share_scope } = accountability;
20
- const cacheKey = `permissions-${hash({ user, role, app, admin, share_scope })}`;
21
- if (cache && env['CACHE_PERMISSIONS'] !== false) {
22
- let cachedPermissions;
23
- try {
24
- cachedPermissions = await getSystemCache(cacheKey);
25
- }
26
- catch (err) {
27
- logger.warn(err, `[cache] Couldn't read key ${cacheKey}. ${err.message}`);
28
- }
29
- if (cachedPermissions) {
30
- if (!cachedPermissions['containDynamicData']) {
31
- return processPermissions(accountability, cachedPermissions['permissions'], {});
32
- }
33
- const cachedFilterContext = await getCacheValue(cache, `filterContext-${hash({ user, role, permissions: cachedPermissions['permissions'] })}`);
34
- if (cachedFilterContext) {
35
- return processPermissions(accountability, cachedPermissions['permissions'], cachedFilterContext);
36
- }
37
- else {
38
- const { permissions: parsedPermissions, requiredPermissionData, containDynamicData, } = parsePermissions(cachedPermissions['permissions']);
39
- permissions = parsedPermissions;
40
- const filterContext = containDynamicData
41
- ? await getFilterContext(schema, accountability, requiredPermissionData)
42
- : {};
43
- if (containDynamicData && env['CACHE_ENABLED'] !== false) {
44
- await setCacheValue(cache, `filterContext-${hash({ user, role, permissions })}`, filterContext);
45
- }
46
- return processPermissions(accountability, permissions, filterContext);
47
- }
48
- }
49
- }
50
- if (accountability.admin !== true) {
51
- const query = database.select('*').from('directus_permissions');
52
- if (accountability.role) {
53
- query.where({ role: accountability.role });
54
- }
55
- else {
56
- query.whereNull('role');
57
- }
58
- const permissionsForRole = await query;
59
- const { permissions: parsedPermissions, requiredPermissionData, containDynamicData, } = parsePermissions(permissionsForRole);
60
- permissions = parsedPermissions;
61
- if (accountability.app === true) {
62
- permissions = mergePermissions('or', permissions, appAccessMinimalPermissions.map((perm) => ({ ...perm, role: accountability.role })));
63
- }
64
- if (accountability.share_scope) {
65
- permissions = mergePermissionsForShare(permissions, accountability, schema);
66
- }
67
- const filterContext = containDynamicData
68
- ? await getFilterContext(schema, accountability, requiredPermissionData)
69
- : {};
70
- if (cache && env['CACHE_PERMISSIONS'] !== false) {
71
- await setSystemCache(cacheKey, { permissions, containDynamicData });
72
- if (containDynamicData && env['CACHE_ENABLED'] !== false) {
73
- await setCacheValue(cache, `filterContext-${hash({ user, role, permissions })}`, filterContext);
74
- }
75
- }
76
- return processPermissions(accountability, permissions, filterContext);
77
- }
78
- return permissions;
79
- }
80
- function parsePermissions(permissions) {
81
- const requiredPermissionData = {
82
- $CURRENT_USER: [],
83
- $CURRENT_ROLE: [],
84
- };
85
- let containDynamicData = false;
86
- permissions = permissions.map((permissionRaw) => {
87
- const permission = cloneDeep(permissionRaw);
88
- if (permission.permissions && typeof permission.permissions === 'string') {
89
- permission.permissions = parseJSON(permission.permissions);
90
- }
91
- if (permission.validation && typeof permission.validation === 'string') {
92
- permission.validation = parseJSON(permission.validation);
93
- }
94
- else if (permission.validation === null) {
95
- permission.validation = {};
96
- }
97
- if (permission.presets && typeof permission.presets === 'string') {
98
- permission.presets = parseJSON(permission.presets);
99
- }
100
- else if (permission.presets === null) {
101
- permission.presets = {};
102
- }
103
- if (permission.fields && typeof permission.fields === 'string') {
104
- permission.fields = permission.fields.split(',');
105
- }
106
- else if (permission.fields === null) {
107
- permission.fields = [];
108
- }
109
- const extractPermissionData = (val) => {
110
- if (typeof val === 'string' && val.startsWith('$CURRENT_USER.')) {
111
- requiredPermissionData.$CURRENT_USER.push(val.replace('$CURRENT_USER.', ''));
112
- containDynamicData = true;
113
- }
114
- if (typeof val === 'string' && val.startsWith('$CURRENT_ROLE.')) {
115
- requiredPermissionData.$CURRENT_ROLE.push(val.replace('$CURRENT_ROLE.', ''));
116
- containDynamicData = true;
117
- }
118
- return val;
119
- };
120
- deepMap(permission.permissions, extractPermissionData);
121
- deepMap(permission.validation, extractPermissionData);
122
- deepMap(permission.presets, extractPermissionData);
123
- return permission;
124
- });
125
- return { permissions, requiredPermissionData, containDynamicData };
126
- }
127
- async function getFilterContext(schema, accountability, requiredPermissionData) {
128
- const usersService = new UsersService({ schema });
129
- const rolesService = new RolesService({ schema });
130
- const filterContext = {};
131
- if (accountability.user && requiredPermissionData.$CURRENT_USER.length > 0) {
132
- filterContext['$CURRENT_USER'] = await usersService.readOne(accountability.user, {
133
- fields: requiredPermissionData.$CURRENT_USER,
134
- });
135
- }
136
- if (accountability.role && requiredPermissionData.$CURRENT_ROLE.length > 0) {
137
- filterContext['$CURRENT_ROLE'] = await rolesService.readOne(accountability.role, {
138
- fields: requiredPermissionData.$CURRENT_ROLE,
139
- });
140
- }
141
- return filterContext;
142
- }
143
- function processPermissions(accountability, permissions, filterContext) {
144
- return permissions.map((permission) => {
145
- permission.permissions = parseFilter(permission.permissions, accountability, filterContext);
146
- permission.validation = parseFilter(permission.validation, accountability, filterContext);
147
- permission.presets = parsePreset(permission.presets, accountability, filterContext);
148
- return permission;
149
- });
150
- }
@@ -1,4 +0,0 @@
1
- import type { Accountability, Filter, Permission, SchemaOverview } from '@directus/types';
2
- export declare function mergePermissionsForShare(currentPermissions: Permission[], accountability: Accountability, schema: SchemaOverview): Permission[];
3
- export declare function traverse(schema: SchemaOverview, rootItemPrimaryKeyField: string, rootItemPrimaryKey: string, currentCollection: string, parentCollections?: string[], path?: string[]): Partial<Permission>[];
4
- export declare function getFilterForPath(type: 'o2m' | 'm2o' | 'a2o', path: string[], rootPrimaryKeyField: string, rootPrimaryKey: string): Filter;
@@ -1,109 +0,0 @@
1
- import { assign, set, uniq } from 'lodash-es';
2
- import { schemaPermissions } from '@directus/system-data';
3
- import { mergePermissions } from './merge-permissions.js';
4
- import { reduceSchema } from './reduce-schema.js';
5
- export function mergePermissionsForShare(currentPermissions, accountability, schema) {
6
- const defaults = {
7
- action: 'read',
8
- role: accountability.role,
9
- collection: '',
10
- permissions: {},
11
- validation: null,
12
- presets: null,
13
- fields: null,
14
- };
15
- const { collection, item } = accountability.share_scope;
16
- const parentPrimaryKeyField = schema.collections[collection].primary;
17
- const reducedSchema = reduceSchema(schema, currentPermissions, ['read']);
18
- const relationalPermissions = traverse(reducedSchema, parentPrimaryKeyField, item, collection);
19
- const parentCollectionPermission = assign({}, defaults, {
20
- collection,
21
- permissions: {
22
- [parentPrimaryKeyField]: {
23
- _eq: item,
24
- },
25
- },
26
- });
27
- // All permissions that will be merged into the original permissions set
28
- const allGeneratedPermissions = [
29
- parentCollectionPermission,
30
- ...relationalPermissions.map((generated) => assign({}, defaults, generated)),
31
- ...schemaPermissions,
32
- ];
33
- // All the collections that are touched through the relational tree from the current root collection, and the schema collections
34
- const allowedCollections = uniq(allGeneratedPermissions.map(({ collection }) => collection));
35
- const generatedPermissions = [];
36
- // Merge all the permissions that relate to the same collection with an _or (this allows you to properly retrieve)
37
- // the items of a collection if you entered that collection from multiple angles
38
- for (const collection of allowedCollections) {
39
- const permissionsForCollection = allGeneratedPermissions.filter((permission) => permission.collection === collection);
40
- if (permissionsForCollection.length > 0) {
41
- generatedPermissions.push(...mergePermissions('or', permissionsForCollection));
42
- }
43
- else {
44
- generatedPermissions.push(...permissionsForCollection);
45
- }
46
- }
47
- // Explicitly filter out permissions to collections unrelated to the root parent item.
48
- const limitedPermissions = currentPermissions.filter(({ action, collection }) => allowedCollections.includes(collection) && action === 'read');
49
- return mergePermissions('and', limitedPermissions, generatedPermissions);
50
- }
51
- export function traverse(schema, rootItemPrimaryKeyField, rootItemPrimaryKey, currentCollection, parentCollections = [], path = []) {
52
- const permissions = [];
53
- // If there's already a permissions rule for the collection we're currently checking, we'll shortcircuit.
54
- // This prevents infinite loop in recursive relationships, like articles->related_articles->articles, or
55
- // articles.author->users.avatar->files.created_by->users.avatar->files.created_by->🔁
56
- if (parentCollections.includes(currentCollection)) {
57
- return permissions;
58
- }
59
- const relationsInCollection = schema.relations.filter((relation) => {
60
- return relation.collection === currentCollection || relation.related_collection === currentCollection;
61
- });
62
- for (const relation of relationsInCollection) {
63
- let type;
64
- if (relation.related_collection === currentCollection) {
65
- type = 'o2m';
66
- }
67
- else if (!relation.related_collection) {
68
- type = 'a2o';
69
- }
70
- else {
71
- type = 'm2o';
72
- }
73
- if (type === 'o2m') {
74
- permissions.push({
75
- collection: relation.collection,
76
- permissions: getFilterForPath(type, [...path, relation.field], rootItemPrimaryKeyField, rootItemPrimaryKey),
77
- });
78
- permissions.push(...traverse(schema, rootItemPrimaryKeyField, rootItemPrimaryKey, relation.collection, [...parentCollections, currentCollection], [...path, relation.field]));
79
- }
80
- if (type === 'a2o' && relation.meta?.one_allowed_collections) {
81
- for (const collection of relation.meta.one_allowed_collections) {
82
- permissions.push({
83
- collection,
84
- permissions: getFilterForPath(type, [...path, `$FOLLOW(${relation.collection},${relation.field},${relation.meta.one_collection_field})`], rootItemPrimaryKeyField, rootItemPrimaryKey),
85
- });
86
- }
87
- }
88
- if (type === 'm2o') {
89
- permissions.push({
90
- collection: relation.related_collection,
91
- permissions: getFilterForPath(type, [...path, `$FOLLOW(${relation.collection},${relation.field})`], rootItemPrimaryKeyField, rootItemPrimaryKey),
92
- });
93
- if (relation.meta?.one_field) {
94
- permissions.push(...traverse(schema, rootItemPrimaryKeyField, rootItemPrimaryKey, relation.related_collection, [...parentCollections, currentCollection], [...path, relation.meta?.one_field]));
95
- }
96
- }
97
- }
98
- return permissions;
99
- }
100
- export function getFilterForPath(type, path, rootPrimaryKeyField, rootPrimaryKey) {
101
- const filter = {};
102
- if (type === 'm2o' || type === 'a2o') {
103
- set(filter, path.reverse(), { [rootPrimaryKeyField]: { _eq: rootPrimaryKey } });
104
- }
105
- else {
106
- set(filter, path.reverse(), { _eq: rootPrimaryKey });
107
- }
108
- return filter;
109
- }
@@ -1,3 +0,0 @@
1
- import type { Permission } from '@directus/types';
2
- export declare function mergePermissions(strategy: 'and' | 'or', ...permissions: Permission[][]): Permission[];
3
- export declare function mergePermission(strategy: 'and' | 'or', currentPerm: Permission, newPerm: Permission): Omit<Permission, 'id' | 'system'>;