acebase-server 1.16.2 → 1.18.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 (252) hide show
  1. package/README.md +180 -10
  2. package/bin/acebase-server.js +8 -0
  3. package/build-vars.js +2 -1
  4. package/dist/cjs/auth.js +88 -88
  5. package/dist/cjs/cluster.js +6 -56
  6. package/dist/cjs/index.d.ts +1 -1
  7. package/dist/cjs/index.js +24 -24
  8. package/dist/cjs/logger.js +73 -73
  9. package/dist/cjs/middleware/404.js +14 -14
  10. package/dist/cjs/middleware/admin-only.js +28 -28
  11. package/dist/cjs/middleware/cache.js +14 -14
  12. package/dist/cjs/middleware/connection.js +49 -49
  13. package/dist/cjs/middleware/context.js +20 -20
  14. package/dist/cjs/middleware/cors.js +50 -50
  15. package/dist/cjs/middleware/swagger.js +17 -17
  16. package/dist/cjs/middleware/user.js +57 -57
  17. package/dist/cjs/oauth-providers/dropbox.js +109 -109
  18. package/dist/cjs/oauth-providers/facebook.js +85 -85
  19. package/dist/cjs/oauth-providers/google.js +119 -119
  20. package/dist/cjs/oauth-providers/index.js +26 -26
  21. package/dist/cjs/oauth-providers/instagram.js +80 -80
  22. package/dist/cjs/oauth-providers/oauth-provider.js +20 -20
  23. package/dist/cjs/oauth-providers/spotify.js +113 -113
  24. package/dist/cjs/routes/auth-change-password.js +87 -87
  25. package/dist/cjs/routes/auth-delete.js +52 -52
  26. package/dist/cjs/routes/auth-forgot-password.js +77 -77
  27. package/dist/cjs/routes/auth-reset-password.js +97 -97
  28. package/dist/cjs/routes/auth-signin.js +46 -46
  29. package/dist/cjs/routes/auth-signout.js +61 -61
  30. package/dist/cjs/routes/auth-signup.js +142 -142
  31. package/dist/cjs/routes/auth-state.js +25 -25
  32. package/dist/cjs/routes/auth-update.js +131 -131
  33. package/dist/cjs/routes/auth-verify-email.js +71 -71
  34. package/dist/cjs/routes/auth.js +57 -54
  35. package/dist/cjs/routes/data-exists.js +33 -33
  36. package/dist/cjs/routes/data-export.js +48 -48
  37. package/dist/cjs/routes/data-get.js +70 -66
  38. package/dist/cjs/routes/data-import.js +54 -54
  39. package/dist/cjs/routes/data-index-create.js +42 -42
  40. package/dist/cjs/routes/data-index-delete.js +33 -33
  41. package/dist/cjs/routes/data-index-list.js +31 -31
  42. package/dist/cjs/routes/data-query.js +80 -70
  43. package/dist/cjs/routes/data-reflect.js +97 -86
  44. package/dist/cjs/routes/data-schema-get.js +36 -36
  45. package/dist/cjs/routes/data-schema-set.js +30 -30
  46. package/dist/cjs/routes/data-schema-test.js +43 -43
  47. package/dist/cjs/routes/data-schemas-list.js +32 -32
  48. package/dist/cjs/routes/data-set.js +85 -75
  49. package/dist/cjs/routes/data-sync-changes.js +81 -67
  50. package/dist/cjs/routes/data-sync-mutations.js +81 -67
  51. package/dist/cjs/routes/data-transaction.js +159 -139
  52. package/dist/cjs/routes/data-update.js +86 -75
  53. package/dist/cjs/routes/data.js +62 -62
  54. package/dist/cjs/routes/docs.js +258 -251
  55. package/dist/cjs/routes/meta-info.js +63 -63
  56. package/dist/cjs/routes/meta-logs.js +49 -49
  57. package/dist/cjs/routes/meta-ping.js +11 -11
  58. package/dist/cjs/routes/meta-stats.js +27 -27
  59. package/dist/cjs/routes/meta.js +19 -19
  60. package/dist/cjs/routes/oauth2-init.js +54 -54
  61. package/dist/cjs/routes/oauth2-refresh.js +42 -42
  62. package/dist/cjs/routes/oauth2-signin.js +265 -265
  63. package/dist/cjs/routes/webmanager.js +26 -26
  64. package/dist/cjs/rules.js +380 -167
  65. package/dist/cjs/sandbox.js +28 -0
  66. package/dist/cjs/schema/user.js +24 -24
  67. package/dist/cjs/server.js +410 -407
  68. package/dist/cjs/settings/email.js +2 -2
  69. package/dist/cjs/settings/index.js +175 -172
  70. package/dist/cjs/shared/clients.js +26 -26
  71. package/dist/cjs/shared/email.js +2 -2
  72. package/dist/cjs/shared/env.js +2 -2
  73. package/dist/cjs/shared/error.js +33 -33
  74. package/dist/cjs/shared/http.js +28 -28
  75. package/dist/cjs/shared/password.js +45 -45
  76. package/dist/cjs/shared/rootpath.js +16 -16
  77. package/dist/cjs/shared/signin.js +143 -143
  78. package/dist/cjs/shared/simple-fetch.js +76 -76
  79. package/dist/cjs/shared/tokens.js +79 -79
  80. package/dist/cjs/shared/validate.js +61 -61
  81. package/dist/cjs/start.js +119 -53
  82. package/dist/cjs/test.js +10 -10
  83. package/dist/cjs/websocket/index.js +331 -319
  84. package/dist/cjs/websocket/manager.js +15 -15
  85. package/dist/cjs/websocket/socket.io.js +76 -76
  86. package/dist/esm/auth.js +75 -75
  87. package/dist/esm/cluster.js +6 -54
  88. package/dist/esm/index.d.ts +1 -1
  89. package/dist/esm/index.js +4 -4
  90. package/dist/esm/logger.js +51 -51
  91. package/dist/esm/middleware/404.js +10 -10
  92. package/dist/esm/middleware/admin-only.js +24 -24
  93. package/dist/esm/middleware/cache.js +10 -10
  94. package/dist/esm/middleware/connection.js +45 -45
  95. package/dist/esm/middleware/context.js +16 -16
  96. package/dist/esm/middleware/cors.js +44 -44
  97. package/dist/esm/middleware/swagger.js +13 -13
  98. package/dist/esm/middleware/user.js +44 -44
  99. package/dist/esm/oauth-providers/dropbox.js +90 -90
  100. package/dist/esm/oauth-providers/facebook.js +66 -66
  101. package/dist/esm/oauth-providers/google.js +96 -96
  102. package/dist/esm/oauth-providers/index.js +18 -18
  103. package/dist/esm/oauth-providers/instagram.js +61 -61
  104. package/dist/esm/oauth-providers/oauth-provider.js +16 -16
  105. package/dist/esm/oauth-providers/spotify.js +92 -92
  106. package/dist/esm/routes/auth-change-password.js +72 -72
  107. package/dist/esm/routes/auth-delete.js +37 -37
  108. package/dist/esm/routes/auth-forgot-password.js +62 -62
  109. package/dist/esm/routes/auth-reset-password.js +81 -81
  110. package/dist/esm/routes/auth-signin.js +33 -33
  111. package/dist/esm/routes/auth-signout.js +47 -47
  112. package/dist/esm/routes/auth-signup.js +127 -127
  113. package/dist/esm/routes/auth-state.js +12 -12
  114. package/dist/esm/routes/auth-update.js +116 -116
  115. package/dist/esm/routes/auth-verify-email.js +57 -57
  116. package/dist/esm/routes/auth.js +53 -50
  117. package/dist/esm/routes/data-exists.js +20 -20
  118. package/dist/esm/routes/data-export.js +35 -35
  119. package/dist/esm/routes/data-get.js +56 -52
  120. package/dist/esm/routes/data-import.js +41 -41
  121. package/dist/esm/routes/data-index-create.js +28 -28
  122. package/dist/esm/routes/data-index-delete.js +20 -20
  123. package/dist/esm/routes/data-index-list.js +18 -18
  124. package/dist/esm/routes/data-query.js +66 -56
  125. package/dist/esm/routes/data-reflect.js +83 -72
  126. package/dist/esm/routes/data-schema-get.js +23 -23
  127. package/dist/esm/routes/data-schema-set.js +17 -17
  128. package/dist/esm/routes/data-schema-test.js +29 -29
  129. package/dist/esm/routes/data-schemas-list.js +19 -19
  130. package/dist/esm/routes/data-set.js +70 -60
  131. package/dist/esm/routes/data-sync-changes.js +67 -53
  132. package/dist/esm/routes/data-sync-mutations.js +67 -53
  133. package/dist/esm/routes/data-transaction.js +142 -123
  134. package/dist/esm/routes/data-update.js +71 -60
  135. package/dist/esm/routes/data.js +58 -58
  136. package/dist/esm/routes/docs.js +252 -245
  137. package/dist/esm/routes/meta-info.js +59 -59
  138. package/dist/esm/routes/meta-logs.js +35 -35
  139. package/dist/esm/routes/meta-ping.js +7 -7
  140. package/dist/esm/routes/meta-stats.js +14 -14
  141. package/dist/esm/routes/meta.js +15 -15
  142. package/dist/esm/routes/oauth2-init.js +41 -41
  143. package/dist/esm/routes/oauth2-refresh.js +29 -29
  144. package/dist/esm/routes/oauth2-signin.js +251 -251
  145. package/dist/esm/routes/webmanager.js +22 -22
  146. package/dist/esm/rules.js +374 -163
  147. package/dist/esm/sandbox.js +12 -0
  148. package/dist/esm/schema/user.js +19 -19
  149. package/dist/esm/server.js +395 -387
  150. package/dist/esm/settings/email.js +1 -1
  151. package/dist/esm/settings/index.js +168 -165
  152. package/dist/esm/shared/clients.js +22 -22
  153. package/dist/esm/shared/email.js +1 -1
  154. package/dist/esm/shared/env.js +1 -1
  155. package/dist/esm/shared/error.js +25 -25
  156. package/dist/esm/shared/http.js +22 -22
  157. package/dist/esm/shared/password.js +38 -38
  158. package/dist/esm/shared/rootpath.js +13 -13
  159. package/dist/esm/shared/signin.js +128 -128
  160. package/dist/esm/shared/simple-fetch.js +59 -59
  161. package/dist/esm/shared/tokens.js +72 -72
  162. package/dist/esm/shared/validate.js +41 -41
  163. package/dist/esm/start.js +116 -50
  164. package/dist/esm/test.js +8 -8
  165. package/dist/esm/websocket/index.js +313 -302
  166. package/dist/esm/websocket/manager.js +11 -11
  167. package/dist/esm/websocket/socket.io.js +71 -71
  168. package/dist/types/auth.d.ts +3 -3
  169. package/dist/types/cluster.d.ts +6 -1
  170. package/dist/types/index.d.ts +4 -4
  171. package/dist/types/logger.d.ts +35 -35
  172. package/dist/types/middleware/404.d.ts +7 -7
  173. package/dist/types/middleware/admin-only.d.ts +19 -19
  174. package/dist/types/middleware/cache.d.ts +3 -3
  175. package/dist/types/middleware/connection.d.ts +7 -7
  176. package/dist/types/middleware/context.d.ts +3 -3
  177. package/dist/types/middleware/cors.d.ts +25 -25
  178. package/dist/types/middleware/swagger.d.ts +3 -3
  179. package/dist/types/middleware/user.d.ts +2 -2
  180. package/dist/types/oauth-providers/dropbox.d.ts +52 -52
  181. package/dist/types/oauth-providers/facebook.d.ts +41 -41
  182. package/dist/types/oauth-providers/google.d.ts +43 -43
  183. package/dist/types/oauth-providers/index.d.ts +10 -10
  184. package/dist/types/oauth-providers/instagram.d.ts +50 -50
  185. package/dist/types/oauth-providers/oauth-provider.d.ts +74 -74
  186. package/dist/types/oauth-providers/spotify.d.ts +53 -53
  187. package/dist/types/routes/auth-change-password.d.ts +20 -20
  188. package/dist/types/routes/auth-delete.d.ts +16 -16
  189. package/dist/types/routes/auth-forgot-password.d.ts +16 -16
  190. package/dist/types/routes/auth-reset-password.d.ts +23 -23
  191. package/dist/types/routes/auth-signin.d.ts +24 -24
  192. package/dist/types/routes/auth-signout.d.ts +14 -14
  193. package/dist/types/routes/auth-signup.d.ts +32 -32
  194. package/dist/types/routes/auth-state.d.ts +13 -13
  195. package/dist/types/routes/auth-update.d.ts +33 -33
  196. package/dist/types/routes/auth-verify-email.d.ts +21 -21
  197. package/dist/types/routes/auth.d.ts +6 -6
  198. package/dist/types/routes/data-exists.d.ts +9 -9
  199. package/dist/types/routes/data-export.d.ts +10 -10
  200. package/dist/types/routes/data-get.d.ts +14 -14
  201. package/dist/types/routes/data-import.d.ts +13 -13
  202. package/dist/types/routes/data-index-create.d.ts +51 -51
  203. package/dist/types/routes/data-index-delete.d.ts +17 -17
  204. package/dist/types/routes/data-index-list.d.ts +21 -21
  205. package/dist/types/routes/data-query.d.ts +49 -49
  206. package/dist/types/routes/data-reflect.d.ts +29 -29
  207. package/dist/types/routes/data-schema-get.d.ts +11 -11
  208. package/dist/types/routes/data-schema-set.d.ts +20 -19
  209. package/dist/types/routes/data-schema-test.d.ts +19 -19
  210. package/dist/types/routes/data-schemas-list.d.ts +11 -11
  211. package/dist/types/routes/data-set.d.ts +27 -27
  212. package/dist/types/routes/data-sync-changes.d.ts +25 -28
  213. package/dist/types/routes/data-sync-mutations.d.ts +25 -28
  214. package/dist/types/routes/data-transaction.d.ts +34 -34
  215. package/dist/types/routes/data-update.d.ts +27 -27
  216. package/dist/types/routes/data.d.ts +3 -3
  217. package/dist/types/routes/docs.d.ts +3 -3
  218. package/dist/types/routes/meta-info.d.ts +11 -11
  219. package/dist/types/routes/meta-logs.d.ts +20 -20
  220. package/dist/types/routes/meta-ping.d.ts +7 -7
  221. package/dist/types/routes/meta-stats.d.ts +13 -13
  222. package/dist/types/routes/meta.d.ts +3 -3
  223. package/dist/types/routes/oauth2-init.d.ts +13 -13
  224. package/dist/types/routes/oauth2-refresh.d.ts +17 -17
  225. package/dist/types/routes/oauth2-signin.d.ts +15 -15
  226. package/dist/types/routes/webmanager.d.ts +3 -3
  227. package/dist/types/rules.d.ts +73 -34
  228. package/dist/types/sandbox.d.ts +3 -0
  229. package/dist/types/schema/user.d.ts +85 -85
  230. package/dist/types/server.d.ts +117 -111
  231. package/dist/types/settings/email.d.ts +14 -14
  232. package/dist/types/settings/index.d.ts +195 -187
  233. package/dist/types/shared/clients.d.ts +46 -46
  234. package/dist/types/shared/email.d.ts +34 -34
  235. package/dist/types/shared/env.d.ts +47 -44
  236. package/dist/types/shared/error.d.ts +15 -15
  237. package/dist/types/shared/http.d.ts +22 -21
  238. package/dist/types/shared/password.d.ts +19 -19
  239. package/dist/types/shared/rootpath.d.ts +2 -2
  240. package/dist/types/shared/signin.d.ts +31 -31
  241. package/dist/types/shared/simple-fetch.d.ts +21 -21
  242. package/dist/types/shared/tokens.d.ts +24 -24
  243. package/dist/types/shared/validate.d.ts +22 -22
  244. package/dist/types/start.d.ts +1 -1
  245. package/dist/types/test.d.ts +1 -1
  246. package/dist/types/websocket/index.d.ts +6 -6
  247. package/dist/types/websocket/manager.d.ts +99 -99
  248. package/dist/types/websocket/socket.io.d.ts +10 -10
  249. package/package.json +7 -4
  250. package/src/routes/data-schema-set.yaml +4 -0
  251. package/src/routes/data-set.yaml +5 -5
  252. package/src/routes/data-update.yaml +4 -4
@@ -1,124 +1,143 @@
1
- import { SchemaValidationError } from 'acebase';
2
- import { ID, Transport } from 'acebase-core';
3
- import { sendBadRequestError, sendError, sendUnauthorizedError, sendUnexpectedError } from '../shared/error.js';
4
- export const TRANSACTION_TIMEOUT_MS = 10000; // 10s to finish a started transaction
5
- export class DataTransactionError extends Error {
6
- constructor(code, message) {
7
- super(message);
8
- this.code = code;
9
- }
10
- }
11
- export const addRoutes = (env) => {
12
- const _transactions = new Map();
13
- // Start transaction endpoint:
14
- env.app.post(`/transaction/${env.db.name}/start`, (req, res) => {
15
- const data = req.body;
16
- const LOG_ACTION = 'data.transaction.start';
17
- const LOG_DETAILS = { ip: req.ip, uid: req.user?.uid ?? null, path: data.path };
18
- const access = env.rules.userHasAccess(req.user, data.path, true);
19
- if (!access.allow) {
20
- env.log.error(LOG_ACTION, 'unauthorized', { ...LOG_DETAILS, rule_code: access.code, rule_path: access.rulePath ?? null }, access.details);
21
- return sendUnauthorizedError(res, access.code, access.message);
22
- }
23
- // Start transaction
24
- const tx = {
25
- id: ID.generate(),
26
- started: Date.now(),
27
- path: data.path,
28
- context: req.context,
29
- finish: undefined,
30
- timeout: setTimeout(() => {
31
- _transactions.delete(tx.id);
32
- tx.finish(); // Finish without value cancels the transaction
33
- }, TRANSACTION_TIMEOUT_MS),
34
- };
35
- _transactions.set(tx.id, tx);
36
- try {
37
- env.debug.verbose(`Transaction ${tx.id} starting...`);
38
- // const ref = db.ref(tx.path);
39
- const donePromise = env.db.api.transaction(tx.path, val => {
40
- env.debug.verbose(`Transaction ${tx.id} started with value: `, val);
41
- const currentValue = Transport.serialize(val);
42
- const promise = new Promise((resolve) => {
43
- tx.finish = (val) => {
44
- env.debug.verbose(`Transaction ${tx.id} finishing with value: `, val);
45
- _transactions.delete(tx.id);
46
- resolve(val);
47
- return donePromise;
48
- };
49
- });
50
- res.send({ id: tx.id, value: currentValue });
51
- return promise;
52
- }, { context: tx.context });
53
- }
54
- catch (err) {
55
- env.debug.error(`failed to start transaction on "${tx.path}":`, err);
56
- env.log.error(LOG_ACTION, err.code ?? 'unexpected', LOG_DETAILS, typeof err.code === 'undefined' ? err : null);
57
- sendUnexpectedError(res, err);
58
- }
59
- });
60
- // Finish transaction endpoint:
61
- env.app.post(`/transaction/${env.db.name}/finish`, async (req, res) => {
62
- const data = req.body;
63
- const LOG_ACTION = 'data.transaction.finish';
64
- const LOG_DETAILS = { ip: req.ip, uid: req.user?.uid ?? null, path: data.path };
65
- const tx = _transactions.get(data.id);
66
- if (!tx || tx.path !== data.path) {
67
- env.log.error(LOG_ACTION, tx ? 'wrong_path' : 'not_found', { ...LOG_DETAILS, id: data.id, tx_path: tx?.path ?? null });
68
- res.statusCode = 410; // Gone
69
- res.send(`transaction not found`);
70
- return;
71
- }
72
- clearTimeout(tx.timeout);
73
- _transactions.delete(tx.id);
74
- const access = env.rules.userHasAccess(req.user, tx.path, true);
75
- if (!access.allow) {
76
- env.log.error(LOG_ACTION, 'unauthorized', { ...LOG_DETAILS, rule_code: access.code, rule_path: access.rulePath ?? null }, access.details);
77
- return sendUnauthorizedError(res, access.code, access.message);
78
- }
79
- // Finish transaction
80
- try {
81
- let cancel = false;
82
- if (typeof data.value === 'object' && (data.value === null || Object.keys(data.value).length === 0)) {
83
- // Returning undefined from a transaction callback should cancel the transaction
84
- // acebase-client (Transport.serialize) serializes value undefined as { val: undefined, map: undefined }, which
85
- // then is sent to the server as an empty object: {}
86
- cancel = true;
87
- }
88
- else if (typeof data.value?.val === 'undefined' || !['string', 'object', 'undefined'].includes(typeof data.value?.map)) {
89
- throw new DataTransactionError('invalid_serialized_value', 'The sent value is not properly serialized');
90
- }
91
- const newValue = cancel ? undefined : Transport.deserialize(data.value);
92
- if (tx.path === '' && req.user?.uid !== 'admin' && newValue !== null && typeof newValue === 'object') {
93
- // Non-admin user: remove any private properties from the update object
94
- Object.keys(newValue).filter(key => key.startsWith('__')).forEach(key => delete newValue[key]);
95
- }
96
- const result = await tx.finish(newValue);
97
- // NEW: capture cursor and return it in the response context header
98
- if (!tx.context) {
99
- tx.context = {};
100
- }
101
- tx.context.acebase_cursor = result.cursor;
102
- res.setHeader('AceBase-Context', JSON.stringify(tx.context));
103
- res.send('done');
104
- }
105
- catch (err) {
106
- tx.finish(); // Finish without value cancels the transaction
107
- if (err instanceof SchemaValidationError) {
108
- env.log.error(LOG_ACTION, 'schema_validation_failed', { ...LOG_DETAILS, reason: err.reason });
109
- res.status(422).send({ code: 'schema_validation_failed', message: err.message });
110
- }
111
- else if (err instanceof DataTransactionError) {
112
- env.log.error(LOG_ACTION, err.code, { ...LOG_DETAILS, message: err.message });
113
- sendBadRequestError(res, err);
114
- }
115
- else {
116
- env.debug.error(`failed to finish transaction on "${tx.path}":`, err);
117
- env.log.error(LOG_ACTION, 'unexpected', LOG_DETAILS, err);
118
- sendError(res, err);
119
- }
120
- }
121
- });
122
- };
123
- export default addRoutes;
1
+ import { SchemaValidationError } from 'acebase';
2
+ import { ID, Transport } from 'acebase-core';
3
+ import { AccessRuleValidationError } from '../rules.js';
4
+ import { sendBadRequestError, sendError, sendUnauthorizedError, sendUnexpectedError } from '../shared/error.js';
5
+ export const TRANSACTION_TIMEOUT_MS = 10000; // 10s to finish a started transaction
6
+ export class DataTransactionError extends Error {
7
+ constructor(code, message) {
8
+ super(message);
9
+ this.code = code;
10
+ }
11
+ }
12
+ export const addRoutes = (env) => {
13
+ const _transactions = new Map();
14
+ // Start transaction endpoint:
15
+ env.router.post(`/transaction/${env.db.name}/start`, async (req, res) => {
16
+ const data = req.body;
17
+ const LOG_ACTION = 'data.transaction.start';
18
+ const LOG_DETAILS = { ip: req.ip, uid: req.user?.uid ?? null, path: data.path };
19
+ // Pre-check read/write access
20
+ const access = await env.rules.isOperationAllowed(req.user, data.path, 'transact');
21
+ if (!access.allow) {
22
+ env.log.error(LOG_ACTION, 'unauthorized', { ...LOG_DETAILS, rule_code: access.code, rule_path: access.rulePath ?? null }, access.details);
23
+ return sendUnauthorizedError(res, access.code, access.message);
24
+ }
25
+ // Start transaction
26
+ const tx = {
27
+ id: ID.generate(),
28
+ started: Date.now(),
29
+ path: data.path,
30
+ context: req.context,
31
+ finish: undefined,
32
+ timeout: setTimeout(() => {
33
+ _transactions.delete(tx.id);
34
+ tx.finish(); // Finish without value cancels the transaction
35
+ }, TRANSACTION_TIMEOUT_MS),
36
+ };
37
+ _transactions.set(tx.id, tx);
38
+ try {
39
+ env.debug.verbose(`Transaction ${tx.id} starting...`);
40
+ // const ref = db.ref(tx.path);
41
+ const donePromise = env.db.api.transaction(tx.path, async (val) => {
42
+ env.debug.verbose(`Transaction ${tx.id} started with value: `, val);
43
+ const access = await env.rules.isOperationAllowed(req.user, data.path, 'get', { value: val, context: req.context });
44
+ if (!access.allow) {
45
+ env.log.error(LOG_ACTION, 'unauthorized', { ...LOG_DETAILS, rule_code: access.code, rule_path: access.rulePath ?? null }, access.details);
46
+ sendUnauthorizedError(res, access.code, access.message);
47
+ return; // Return undefined to cancel transaction
48
+ }
49
+ const currentValue = Transport.serialize(val);
50
+ const promise = new Promise((resolve) => {
51
+ tx.finish = (val) => {
52
+ env.debug.verbose(`Transaction ${tx.id} finishing with value: `, val);
53
+ _transactions.delete(tx.id);
54
+ resolve(val);
55
+ return donePromise;
56
+ };
57
+ });
58
+ res.send({ id: tx.id, value: currentValue });
59
+ return promise;
60
+ }, { context: tx.context });
61
+ }
62
+ catch (err) {
63
+ await tx?.finish(); // Finish without value to cancel the transaction
64
+ env.debug.error(`failed to start transaction on "${tx.path}":`, err);
65
+ env.log.error(LOG_ACTION, err.code ?? 'unexpected', LOG_DETAILS, typeof err.code === 'undefined' ? err : null);
66
+ sendUnexpectedError(res, err);
67
+ }
68
+ });
69
+ // Finish transaction endpoint:
70
+ env.router.post(`/transaction/${env.db.name}/finish`, async (req, res) => {
71
+ const data = req.body;
72
+ const LOG_ACTION = 'data.transaction.finish';
73
+ const LOG_DETAILS = { ip: req.ip, uid: req.user?.uid ?? null, path: data.path };
74
+ const tx = _transactions.get(data.id);
75
+ if (!tx || tx.path !== data.path) {
76
+ env.log.error(LOG_ACTION, tx ? 'wrong_path' : 'not_found', { ...LOG_DETAILS, id: data.id, tx_path: tx?.path ?? null });
77
+ res.statusCode = 410; // Gone
78
+ res.send(`transaction not found`);
79
+ return;
80
+ }
81
+ clearTimeout(tx.timeout);
82
+ _transactions.delete(tx.id);
83
+ // Finish transaction
84
+ try {
85
+ // Check again if a 'write' to this path is allowed by this user
86
+ let access = await env.rules.isOperationAllowed(req.user, tx.path, 'set');
87
+ if (!access.allow) {
88
+ throw new AccessRuleValidationError(access);
89
+ }
90
+ let cancel = false;
91
+ if (typeof data.value === 'object' && (data.value === null || Object.keys(data.value).length === 0)) {
92
+ // Returning undefined from a transaction callback should cancel the transaction
93
+ // acebase-client (Transport.serialize) serializes value undefined as { val: undefined, map: undefined }, which
94
+ // then is sent to the server as an empty object: {}
95
+ cancel = true;
96
+ }
97
+ else if (typeof data.value?.val === 'undefined' || !['string', 'object', 'undefined'].includes(typeof data.value?.map)) {
98
+ throw new DataTransactionError('invalid_serialized_value', 'The sent value is not properly serialized');
99
+ }
100
+ const newValue = cancel ? undefined : Transport.deserialize(data.value);
101
+ if (tx.path === '' && req.user?.uid !== 'admin' && newValue !== null && typeof newValue === 'object') {
102
+ // Non-admin user: remove any private properties from the update object
103
+ Object.keys(newValue).filter(key => key.startsWith('__')).forEach(key => delete newValue[key]);
104
+ }
105
+ // Check if the value to be written is allowed
106
+ access = await env.rules.isOperationAllowed(req.user, tx.path, 'set', { value: newValue, context: tx.context });
107
+ if (!access.allow) {
108
+ throw new AccessRuleValidationError(access);
109
+ }
110
+ const result = await tx.finish(newValue);
111
+ // NEW: capture cursor and return it in the response context header
112
+ if (!tx.context) {
113
+ tx.context = {};
114
+ }
115
+ tx.context.acebase_cursor = result.cursor;
116
+ res.setHeader('AceBase-Context', JSON.stringify(tx.context));
117
+ res.send('done');
118
+ }
119
+ catch (err) {
120
+ tx.finish(); // Finish without value cancels the transaction
121
+ if (err instanceof AccessRuleValidationError) {
122
+ const access = err.result;
123
+ env.log.error(LOG_ACTION, 'unauthorized', { ...LOG_DETAILS, rule_code: access.code, rule_path: access.rulePath ?? null }, access.details);
124
+ return sendUnauthorizedError(res, access.code, access.message);
125
+ }
126
+ else if (err instanceof SchemaValidationError) {
127
+ env.log.error(LOG_ACTION, 'schema_validation_failed', { ...LOG_DETAILS, reason: err.reason });
128
+ res.status(422).send({ code: 'schema_validation_failed', message: err.message });
129
+ }
130
+ else if (err instanceof DataTransactionError) {
131
+ env.log.error(LOG_ACTION, err.code, { ...LOG_DETAILS, message: err.message });
132
+ sendBadRequestError(res, err);
133
+ }
134
+ else {
135
+ env.debug.error(`failed to finish transaction on "${tx.path}":`, err);
136
+ env.log.error(LOG_ACTION, 'unexpected', LOG_DETAILS, err);
137
+ sendError(res, err);
138
+ }
139
+ }
140
+ });
141
+ };
142
+ export default addRoutes;
124
143
  //# sourceMappingURL=data-transaction.js.map
@@ -1,61 +1,72 @@
1
- import { SchemaValidationError } from 'acebase';
2
- import { Transport } from 'acebase-core';
3
- import { sendBadRequestError, sendError, sendUnauthorizedError } from '../shared/error.js';
4
- export class UpdateDataError extends Error {
5
- constructor(code, message) {
6
- super(message);
7
- this.code = code;
8
- }
9
- }
10
- export const addRoute = (env) => {
11
- env.app.post(`/data/${env.db.name}/*`, async (req, res) => {
12
- const path = req.path.slice(env.db.name.length + 7);
13
- const LOG_ACTION = 'data.update';
14
- const LOG_DETAILS = { ip: req.ip, uid: req.user?.uid ?? null, path };
15
- const access = env.rules.userHasAccess(req.user, path, true);
16
- if (!access.allow) {
17
- env.log.error(LOG_ACTION, 'unauthorized', { ...LOG_DETAILS, rule_code: access.code, rule_path: access.rulePath ?? null, rule_error: access.details?.message ?? null });
18
- return sendUnauthorizedError(res, access.code, access.message);
19
- }
20
- try {
21
- const data = req.body;
22
- if (typeof data?.val === 'undefined' || !['string', 'object', 'undefined'].includes(typeof data?.map)) {
23
- throw new UpdateDataError('invalid_serialized_value', 'The sent value is not properly serialized');
24
- }
25
- const val = Transport.deserialize(data);
26
- if (path === '' && req.user?.uid !== 'admin' && val !== null && typeof val === 'object') {
27
- // Non-admin user: remove any private properties from the update object
28
- Object.keys(val).filter(key => key.startsWith('__')).forEach(key => delete val[key]);
29
- }
30
- // Schema validation moved to storage, no need to check here but an early check won't do no harm!
31
- const validation = await env.db.schema.check(path, val, true);
32
- if (!validation.ok) {
33
- throw new SchemaValidationError(validation.reason);
34
- }
35
- await env.db.ref(path)
36
- .context(req.context)
37
- .update(val);
38
- // NEW: add cursor to response context, which was added to the request context in `acebase_cursor` if transaction logging is enabled
39
- const returnContext = { acebase_cursor: req.context.acebase_cursor };
40
- res.setHeader('AceBase-Context', JSON.stringify(returnContext));
41
- res.send({ success: true });
42
- }
43
- catch (err) {
44
- if (err instanceof SchemaValidationError) {
45
- env.log.error(LOG_ACTION, 'schema_validation_failed', { ...LOG_DETAILS, reason: err.reason });
46
- res.status(422).send({ code: 'schema_validation_failed', message: err.message });
47
- }
48
- else if (err instanceof UpdateDataError) {
49
- env.log.error(LOG_ACTION, err.code, { ...LOG_DETAILS, message: err.message });
50
- sendBadRequestError(res, err);
51
- }
52
- else {
53
- env.debug.error(`failed to update "${path}":`, err);
54
- env.log.error(LOG_ACTION, 'unexpected', LOG_DETAILS, err);
55
- sendError(res, err);
56
- }
57
- }
58
- });
59
- };
60
- export default addRoute;
1
+ import { SchemaValidationError } from 'acebase';
2
+ import { Transport } from 'acebase-core';
3
+ import { AccessRuleValidationError } from '../rules.js';
4
+ import { sendBadRequestError, sendError, sendUnauthorizedError } from '../shared/error.js';
5
+ export class UpdateDataError extends Error {
6
+ constructor(code, message) {
7
+ super(message);
8
+ this.code = code;
9
+ }
10
+ }
11
+ export const addRoute = (env) => {
12
+ env.router.post(`/data/${env.db.name}/*`, async (req, res) => {
13
+ const path = req.path.slice(env.db.name.length + 7);
14
+ const LOG_ACTION = 'data.update';
15
+ const LOG_DETAILS = { ip: req.ip, uid: req.user?.uid ?? null, path };
16
+ try {
17
+ // Pre-check 'write' access
18
+ let access = await env.rules.isOperationAllowed(req.user, path, 'update');
19
+ if (!access.allow) {
20
+ throw new AccessRuleValidationError(access);
21
+ }
22
+ const data = req.body;
23
+ if (typeof data?.val === 'undefined' || !['string', 'object', 'undefined'].includes(typeof data?.map)) {
24
+ throw new UpdateDataError('invalid_serialized_value', 'The sent value is not properly serialized');
25
+ }
26
+ const val = Transport.deserialize(data);
27
+ if (path === '' && req.user?.uid !== 'admin' && val !== null && typeof val === 'object') {
28
+ // Non-admin user: remove any private properties from the update object
29
+ Object.keys(val).filter(key => key.startsWith('__')).forEach(key => delete val[key]);
30
+ }
31
+ // Check 'update' access
32
+ access = await env.rules.isOperationAllowed(req.user, path, 'update', { value: val, context: req.context });
33
+ if (!access.allow) {
34
+ throw new AccessRuleValidationError(access);
35
+ }
36
+ // Schema validation moved to storage, no need to check here but an early check won't do no harm!
37
+ const validation = await env.db.schema.check(path, val, true);
38
+ if (!validation.ok) {
39
+ throw new SchemaValidationError(validation.reason);
40
+ }
41
+ await env.db.ref(path)
42
+ .context(req.context)
43
+ .update(val);
44
+ // NEW: add cursor to response context, which was added to the request context in `acebase_cursor` if transaction logging is enabled
45
+ const returnContext = { acebase_cursor: req.context.acebase_cursor };
46
+ res.setHeader('AceBase-Context', JSON.stringify(returnContext));
47
+ res.send({ success: true });
48
+ }
49
+ catch (err) {
50
+ if (err instanceof AccessRuleValidationError) {
51
+ const access = err.result;
52
+ env.log.error(LOG_ACTION, 'unauthorized', { ...LOG_DETAILS, rule_code: access.code, rule_path: access.rulePath ?? null, rule_error: access.details?.message ?? null });
53
+ return sendUnauthorizedError(res, access.code, access.message);
54
+ }
55
+ if (err instanceof SchemaValidationError) {
56
+ env.log.error(LOG_ACTION, 'schema_validation_failed', { ...LOG_DETAILS, reason: err.reason });
57
+ res.status(422).send({ code: 'schema_validation_failed', message: err.message });
58
+ }
59
+ else if (err instanceof UpdateDataError) {
60
+ env.log.error(LOG_ACTION, err.code, { ...LOG_DETAILS, message: err.message });
61
+ sendBadRequestError(res, err);
62
+ }
63
+ else {
64
+ env.debug.error(`failed to update "${path}":`, err);
65
+ env.log.error(LOG_ACTION, 'unexpected', LOG_DETAILS, err);
66
+ sendError(res, err);
67
+ }
68
+ }
69
+ });
70
+ };
71
+ export default addRoute;
61
72
  //# sourceMappingURL=data-update.js.map
@@ -1,59 +1,59 @@
1
- import addContextMiddleware from '../middleware/context.js';
2
- import addGetDataRoute from './data-get.js';
3
- import addUpdateDataRoute from './data-update.js';
4
- import addSetDataRoute from './data-set.js';
5
- import addTransactionRoutes from './data-transaction.js';
6
- import addExistsRoute from './data-exists.js';
7
- import addReflectRoute from './data-reflect.js';
8
- import addImportDataRoute from './data-import.js';
9
- import addExportDataRoute from './data-export.js';
10
- import addQueryRoute from './data-query.js';
11
- // Indexes:
12
- import addListIndexesRoute from './data-index-list.js';
13
- import addCreateIndexRoute from './data-index-create.js';
14
- import addDeleteIndexRoute from './data-index-delete.js';
15
- // Schemas:
16
- import addListSchemasRoute from './data-schemas-list.js';
17
- import addGetSchemaRoute from './data-schema-get.js';
18
- import addSetSchemaRoute from './data-schema-set.js';
19
- import addTestSchemaRoute from './data-schema-test.js';
20
- // Sycnronization:
21
- import addSyncMutationsRoute from './data-sync-mutations.js';
22
- import addSyncChangesRoute from './data-sync-changes.js';
23
- export const addRoutes = (env) => {
24
- // Add context middleware that handles AceBase-Context header
25
- addContextMiddleware(env);
26
- // Add get data endpoint
27
- addGetDataRoute(env);
28
- // Add update data endpoint
29
- addUpdateDataRoute(env);
30
- // Add set data endpoint
31
- addSetDataRoute(env);
32
- // add transaction routes (start & finish)
33
- addTransactionRoutes(env);
34
- // Add exists endpoint
35
- addExistsRoute(env);
36
- // Add reflect endpoint
37
- addReflectRoute(env);
38
- // Add import endpoint
39
- addImportDataRoute(env);
40
- // Add export endpoint
41
- addExportDataRoute(env);
42
- // Add query endpoint
43
- addQueryRoute(env);
44
- // Add index endpoints:
45
- addListIndexesRoute(env); // list indexes
46
- addCreateIndexRoute(env); // create index
47
- addDeleteIndexRoute(env); // delete index
48
- // Add schema endpoints:
49
- addListSchemasRoute(env); // list all
50
- addGetSchemaRoute(env); // get schema
51
- addSetSchemaRoute(env); // set schema
52
- addTestSchemaRoute(env); // test
53
- // Add sync mutations endpoint
54
- addSyncMutationsRoute(env);
55
- // add sync changes endpoint
56
- addSyncChangesRoute(env);
57
- };
58
- export default addRoutes;
1
+ import addContextMiddleware from '../middleware/context.js';
2
+ import addGetDataRoute from './data-get.js';
3
+ import addUpdateDataRoute from './data-update.js';
4
+ import addSetDataRoute from './data-set.js';
5
+ import addTransactionRoutes from './data-transaction.js';
6
+ import addExistsRoute from './data-exists.js';
7
+ import addReflectRoute from './data-reflect.js';
8
+ import addImportDataRoute from './data-import.js';
9
+ import addExportDataRoute from './data-export.js';
10
+ import addQueryRoute from './data-query.js';
11
+ // Indexes:
12
+ import addListIndexesRoute from './data-index-list.js';
13
+ import addCreateIndexRoute from './data-index-create.js';
14
+ import addDeleteIndexRoute from './data-index-delete.js';
15
+ // Schemas:
16
+ import addListSchemasRoute from './data-schemas-list.js';
17
+ import addGetSchemaRoute from './data-schema-get.js';
18
+ import addSetSchemaRoute from './data-schema-set.js';
19
+ import addTestSchemaRoute from './data-schema-test.js';
20
+ // Sycnronization:
21
+ import addSyncMutationsRoute from './data-sync-mutations.js';
22
+ import addSyncChangesRoute from './data-sync-changes.js';
23
+ export const addRoutes = (env) => {
24
+ // Add context middleware that handles AceBase-Context header
25
+ addContextMiddleware(env);
26
+ // Add get data endpoint
27
+ addGetDataRoute(env);
28
+ // Add update data endpoint
29
+ addUpdateDataRoute(env);
30
+ // Add set data endpoint
31
+ addSetDataRoute(env);
32
+ // add transaction routes (start & finish)
33
+ addTransactionRoutes(env);
34
+ // Add exists endpoint
35
+ addExistsRoute(env);
36
+ // Add reflect endpoint
37
+ addReflectRoute(env);
38
+ // Add import endpoint
39
+ addImportDataRoute(env);
40
+ // Add export endpoint
41
+ addExportDataRoute(env);
42
+ // Add query endpoint
43
+ addQueryRoute(env);
44
+ // Add index endpoints:
45
+ addListIndexesRoute(env); // list indexes
46
+ addCreateIndexRoute(env); // create index
47
+ addDeleteIndexRoute(env); // delete index
48
+ // Add schema endpoints:
49
+ addListSchemasRoute(env); // list all
50
+ addGetSchemaRoute(env); // get schema
51
+ addSetSchemaRoute(env); // set schema
52
+ addTestSchemaRoute(env); // test
53
+ // Add sync mutations endpoint
54
+ addSyncMutationsRoute(env);
55
+ // add sync changes endpoint
56
+ addSyncChangesRoute(env);
57
+ };
58
+ export default addRoutes;
59
59
  //# sourceMappingURL=data.js.map