acebase-server 1.10.0 → 1.12.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 (250) hide show
  1. package/dist/cjs/index.js +16 -0
  2. package/dist/cjs/index.js.map +1 -1
  3. package/dist/cjs/logger.js +74 -0
  4. package/dist/cjs/logger.js.map +1 -0
  5. package/dist/cjs/middleware/admin-only.js +29 -0
  6. package/dist/cjs/middleware/admin-only.js.map +1 -0
  7. package/dist/cjs/middleware/user.js +4 -4
  8. package/dist/cjs/middleware/user.js.map +1 -1
  9. package/dist/cjs/oauth-providers/dropbox.js +3 -2
  10. package/dist/cjs/oauth-providers/dropbox.js.map +1 -1
  11. package/dist/cjs/oauth-providers/facebook.js +3 -2
  12. package/dist/cjs/oauth-providers/facebook.js.map +1 -1
  13. package/dist/cjs/oauth-providers/google.js +3 -2
  14. package/dist/cjs/oauth-providers/google.js.map +1 -1
  15. package/dist/cjs/oauth-providers/index.js.map +1 -1
  16. package/dist/cjs/oauth-providers/instagram.js +3 -2
  17. package/dist/cjs/oauth-providers/instagram.js.map +1 -1
  18. package/dist/cjs/oauth-providers/oauth-provider.js +23 -0
  19. package/dist/cjs/oauth-providers/oauth-provider.js.map +1 -1
  20. package/dist/cjs/oauth-providers/spotify.js +3 -2
  21. package/dist/cjs/oauth-providers/spotify.js.map +1 -1
  22. package/dist/cjs/routes/auth-change-password.js +7 -4
  23. package/dist/cjs/routes/auth-change-password.js.map +1 -1
  24. package/dist/cjs/routes/auth-delete.js +9 -7
  25. package/dist/cjs/routes/auth-delete.js.map +1 -1
  26. package/dist/cjs/routes/auth-forgot-password.js +9 -6
  27. package/dist/cjs/routes/auth-forgot-password.js.map +1 -1
  28. package/dist/cjs/routes/auth-reset-password.js +5 -3
  29. package/dist/cjs/routes/auth-reset-password.js.map +1 -1
  30. package/dist/cjs/routes/auth-signout.js +6 -4
  31. package/dist/cjs/routes/auth-signout.js.map +1 -1
  32. package/dist/cjs/routes/auth-signup.js +17 -15
  33. package/dist/cjs/routes/auth-signup.js.map +1 -1
  34. package/dist/cjs/routes/auth-update.js +9 -6
  35. package/dist/cjs/routes/auth-update.js.map +1 -1
  36. package/dist/cjs/routes/auth-verify-email.js +6 -3
  37. package/dist/cjs/routes/auth-verify-email.js.map +1 -1
  38. package/dist/cjs/routes/data-index-create.js +3 -5
  39. package/dist/cjs/routes/data-index-create.js.map +1 -1
  40. package/dist/cjs/routes/data-index-delete.js +2 -4
  41. package/dist/cjs/routes/data-index-delete.js.map +1 -1
  42. package/dist/cjs/routes/data-index-list.js +2 -4
  43. package/dist/cjs/routes/data-index-list.js.map +1 -1
  44. package/dist/cjs/routes/data-reflect.js +2 -4
  45. package/dist/cjs/routes/data-reflect.js.map +1 -1
  46. package/dist/cjs/routes/data-schema-get.js +2 -4
  47. package/dist/cjs/routes/data-schema-get.js.map +1 -1
  48. package/dist/cjs/routes/data-schema-set.js +2 -4
  49. package/dist/cjs/routes/data-schema-set.js.map +1 -1
  50. package/dist/cjs/routes/data-schema-test.js +2 -4
  51. package/dist/cjs/routes/data-schema-test.js.map +1 -1
  52. package/dist/cjs/routes/data-schemas-list.js +2 -4
  53. package/dist/cjs/routes/data-schemas-list.js.map +1 -1
  54. package/dist/cjs/routes/data-set.js +11 -7
  55. package/dist/cjs/routes/data-set.js.map +1 -1
  56. package/dist/cjs/routes/data-sync-changes.js.map +1 -1
  57. package/dist/cjs/routes/data-sync-mutations.js.map +1 -1
  58. package/dist/cjs/routes/data-transaction.js +30 -10
  59. package/dist/cjs/routes/data-transaction.js.map +1 -1
  60. package/dist/cjs/routes/data-update.js +11 -6
  61. package/dist/cjs/routes/data-update.js.map +1 -1
  62. package/dist/cjs/routes/meta-info.js.map +1 -1
  63. package/dist/cjs/routes/meta-logs.js +50 -0
  64. package/dist/cjs/routes/meta-logs.js.map +1 -0
  65. package/dist/cjs/routes/meta.js +3 -0
  66. package/dist/cjs/routes/meta.js.map +1 -1
  67. package/dist/cjs/routes/oauth2-signin.js +15 -11
  68. package/dist/cjs/routes/oauth2-signin.js.map +1 -1
  69. package/dist/cjs/rules.js +5 -5
  70. package/dist/cjs/rules.js.map +1 -1
  71. package/dist/cjs/server.js +6 -4
  72. package/dist/cjs/server.js.map +1 -1
  73. package/dist/cjs/settings/index.js +6 -7
  74. package/dist/cjs/settings/index.js.map +1 -1
  75. package/dist/cjs/shared/clients.js.map +1 -1
  76. package/dist/cjs/shared/env.js.map +1 -1
  77. package/dist/cjs/shared/http.js.map +1 -1
  78. package/dist/cjs/shared/signin.js +8 -3
  79. package/dist/cjs/shared/signin.js.map +1 -1
  80. package/dist/cjs/start.js +3 -0
  81. package/dist/cjs/start.js.map +1 -1
  82. package/dist/cjs/websocket/index.js +43 -24
  83. package/dist/cjs/websocket/index.js.map +1 -1
  84. package/dist/cjs/websocket/socket.io.js +8 -11
  85. package/dist/cjs/websocket/socket.io.js.map +1 -1
  86. package/dist/esm/index.js +2 -0
  87. package/dist/esm/index.js.map +1 -1
  88. package/dist/esm/logger.js +52 -0
  89. package/dist/esm/logger.js.map +1 -0
  90. package/dist/esm/middleware/admin-only.js +25 -0
  91. package/dist/esm/middleware/admin-only.js.map +1 -0
  92. package/dist/esm/middleware/user.js +4 -4
  93. package/dist/esm/middleware/user.js.map +1 -1
  94. package/dist/esm/oauth-providers/dropbox.js +3 -2
  95. package/dist/esm/oauth-providers/dropbox.js.map +1 -1
  96. package/dist/esm/oauth-providers/facebook.js +3 -2
  97. package/dist/esm/oauth-providers/facebook.js.map +1 -1
  98. package/dist/esm/oauth-providers/google.js +3 -2
  99. package/dist/esm/oauth-providers/google.js.map +1 -1
  100. package/dist/esm/oauth-providers/index.js.map +1 -1
  101. package/dist/esm/oauth-providers/instagram.js +3 -2
  102. package/dist/esm/oauth-providers/instagram.js.map +1 -1
  103. package/dist/esm/oauth-providers/oauth-provider.js +21 -1
  104. package/dist/esm/oauth-providers/oauth-provider.js.map +1 -1
  105. package/dist/esm/oauth-providers/spotify.js +3 -2
  106. package/dist/esm/oauth-providers/spotify.js.map +1 -1
  107. package/dist/esm/routes/auth-change-password.js +6 -3
  108. package/dist/esm/routes/auth-change-password.js.map +1 -1
  109. package/dist/esm/routes/auth-delete.js +7 -5
  110. package/dist/esm/routes/auth-delete.js.map +1 -1
  111. package/dist/esm/routes/auth-forgot-password.js +8 -6
  112. package/dist/esm/routes/auth-forgot-password.js.map +1 -1
  113. package/dist/esm/routes/auth-reset-password.js +4 -2
  114. package/dist/esm/routes/auth-reset-password.js.map +1 -1
  115. package/dist/esm/routes/auth-signout.js +4 -2
  116. package/dist/esm/routes/auth-signout.js.map +1 -1
  117. package/dist/esm/routes/auth-signup.js +12 -10
  118. package/dist/esm/routes/auth-signup.js.map +1 -1
  119. package/dist/esm/routes/auth-update.js +8 -6
  120. package/dist/esm/routes/auth-update.js.map +1 -1
  121. package/dist/esm/routes/auth-verify-email.js +6 -2
  122. package/dist/esm/routes/auth-verify-email.js.map +1 -1
  123. package/dist/esm/routes/data-index-create.js +4 -6
  124. package/dist/esm/routes/data-index-create.js.map +1 -1
  125. package/dist/esm/routes/data-index-delete.js +3 -5
  126. package/dist/esm/routes/data-index-delete.js.map +1 -1
  127. package/dist/esm/routes/data-index-list.js +3 -5
  128. package/dist/esm/routes/data-index-list.js.map +1 -1
  129. package/dist/esm/routes/data-reflect.js +1 -4
  130. package/dist/esm/routes/data-reflect.js.map +1 -1
  131. package/dist/esm/routes/data-schema-get.js +3 -5
  132. package/dist/esm/routes/data-schema-get.js.map +1 -1
  133. package/dist/esm/routes/data-schema-set.js +3 -5
  134. package/dist/esm/routes/data-schema-set.js.map +1 -1
  135. package/dist/esm/routes/data-schema-test.js +3 -5
  136. package/dist/esm/routes/data-schema-test.js.map +1 -1
  137. package/dist/esm/routes/data-schemas-list.js +3 -5
  138. package/dist/esm/routes/data-schemas-list.js.map +1 -1
  139. package/dist/esm/routes/data-set.js +9 -5
  140. package/dist/esm/routes/data-set.js.map +1 -1
  141. package/dist/esm/routes/data-sync-changes.js.map +1 -1
  142. package/dist/esm/routes/data-sync-mutations.js.map +1 -1
  143. package/dist/esm/routes/data-transaction.js +28 -8
  144. package/dist/esm/routes/data-transaction.js.map +1 -1
  145. package/dist/esm/routes/data-update.js +9 -4
  146. package/dist/esm/routes/data-update.js.map +1 -1
  147. package/dist/esm/routes/meta-info.js.map +1 -1
  148. package/dist/esm/routes/meta-logs.js +36 -0
  149. package/dist/esm/routes/meta-logs.js.map +1 -0
  150. package/dist/esm/routes/meta.js +3 -0
  151. package/dist/esm/routes/meta.js.map +1 -1
  152. package/dist/esm/routes/oauth2-signin.js +14 -10
  153. package/dist/esm/routes/oauth2-signin.js.map +1 -1
  154. package/dist/esm/rules.js +5 -5
  155. package/dist/esm/rules.js.map +1 -1
  156. package/dist/esm/server.js +6 -4
  157. package/dist/esm/server.js.map +1 -1
  158. package/dist/esm/settings/index.js +5 -6
  159. package/dist/esm/settings/index.js.map +1 -1
  160. package/dist/esm/shared/clients.js.map +1 -1
  161. package/dist/esm/shared/env.js.map +1 -1
  162. package/dist/esm/shared/http.js.map +1 -1
  163. package/dist/esm/shared/signin.js +7 -3
  164. package/dist/esm/shared/signin.js.map +1 -1
  165. package/dist/esm/start.js +3 -0
  166. package/dist/esm/start.js.map +1 -1
  167. package/dist/esm/websocket/index.js +38 -23
  168. package/dist/esm/websocket/index.js.map +1 -1
  169. package/dist/esm/websocket/socket.io.js +9 -11
  170. package/dist/esm/websocket/socket.io.js.map +1 -1
  171. package/dist/types/index.d.ts +2 -0
  172. package/dist/types/logger.d.ts +35 -0
  173. package/dist/types/middleware/admin-only.d.ts +19 -0
  174. package/dist/types/oauth-providers/dropbox.d.ts +3 -14
  175. package/dist/types/oauth-providers/facebook.d.ts +3 -7
  176. package/dist/types/oauth-providers/google.d.ts +3 -7
  177. package/dist/types/oauth-providers/index.d.ts +2 -10
  178. package/dist/types/oauth-providers/instagram.d.ts +3 -7
  179. package/dist/types/oauth-providers/oauth-provider.d.ts +25 -21
  180. package/dist/types/oauth-providers/spotify.d.ts +3 -7
  181. package/dist/types/routes/data-query.d.ts +1 -1
  182. package/dist/types/routes/meta-logs.d.ts +20 -0
  183. package/dist/types/rules.d.ts +4 -4
  184. package/dist/types/server.d.ts +9 -7
  185. package/dist/types/settings/email.d.ts +1 -1
  186. package/dist/types/settings/index.d.ts +5 -6
  187. package/dist/types/shared/clients.d.ts +3 -1
  188. package/dist/types/shared/env.d.ts +6 -4
  189. package/dist/types/shared/http.d.ts +2 -0
  190. package/dist/types/shared/signin.d.ts +1 -1
  191. package/dist/types/websocket/index.d.ts +4 -0
  192. package/dist/types/websocket/manager.d.ts +1 -1
  193. package/package.json +12 -11
  194. package/src/index.ts +3 -1
  195. package/src/logger.ts +56 -0
  196. package/src/middleware/admin-only.ts +29 -0
  197. package/src/middleware/user.ts +4 -4
  198. package/src/oauth-providers/dropbox.ts +5 -4
  199. package/src/oauth-providers/facebook.ts +5 -4
  200. package/src/oauth-providers/google.ts +5 -4
  201. package/src/oauth-providers/index.ts +2 -1
  202. package/src/oauth-providers/instagram.ts +5 -4
  203. package/src/oauth-providers/oauth-provider.ts +14 -4
  204. package/src/oauth-providers/spotify.ts +5 -4
  205. package/src/placeholder.d.ts +12 -0
  206. package/src/routes/auth-change-password.ts +6 -3
  207. package/src/routes/auth-delete.ts +7 -5
  208. package/src/routes/auth-forgot-password.ts +10 -6
  209. package/src/routes/auth-reset-password.ts +5 -2
  210. package/src/routes/auth-signout.ts +5 -2
  211. package/src/routes/auth-signup.ts +13 -10
  212. package/src/routes/auth-update.ts +8 -6
  213. package/src/routes/auth-verify-email.ts +11 -3
  214. package/src/routes/data-index-create.ts +4 -7
  215. package/src/routes/data-index-delete.ts +3 -6
  216. package/src/routes/data-index-list.ts +3 -6
  217. package/src/routes/data-query.ts +1 -1
  218. package/src/routes/data-reflect.ts +1 -4
  219. package/src/routes/data-schema-get.ts +3 -5
  220. package/src/routes/data-schema-set.ts +3 -6
  221. package/src/routes/data-schema-test.ts +3 -6
  222. package/src/routes/data-schemas-list.ts +3 -5
  223. package/src/routes/data-set.ts +14 -6
  224. package/src/routes/data-set.yaml +7 -1
  225. package/src/routes/data-sync-changes.ts +1 -1
  226. package/src/routes/data-sync-mutations.ts +1 -1
  227. package/src/routes/data-transaction-finish.yaml +6 -0
  228. package/src/routes/data-transaction.ts +35 -11
  229. package/src/routes/data-update.ts +12 -4
  230. package/src/routes/data-update.yaml +7 -1
  231. package/src/routes/meta-info.ts +1 -1
  232. package/src/routes/meta-logs.ts +57 -0
  233. package/src/routes/meta.ts +4 -0
  234. package/src/routes/oauth2-signin.ts +17 -12
  235. package/src/rules.ts +8 -8
  236. package/src/server.ts +13 -9
  237. package/src/settings/email.ts +1 -1
  238. package/src/settings/index.ts +7 -7
  239. package/src/shared/clients.ts +1 -1
  240. package/src/shared/env.ts +5 -4
  241. package/src/shared/http.ts +2 -0
  242. package/src/shared/signin.ts +10 -4
  243. package/src/start.ts +3 -0
  244. package/src/websocket/index.ts +41 -24
  245. package/src/websocket/manager.ts +1 -1
  246. package/src/websocket/socket.io.ts +9 -10
  247. package/webmanager/acebase-client-browser.min.js +16 -0
  248. package/webmanager/index.html +2 -2
  249. package/webmanager/index.js +3 -6
  250. package/.vscode/launch.json +0 -24
@@ -20,14 +20,16 @@ export const addRoute = (env: RouteInitEnvironment) => {
20
20
  env.app.post(`/auth/${env.db.name}/change_password`, async (req: Request, res) => {
21
21
  let access_token = req.user?.access_token;
22
22
  const details = req.body;
23
+ const LOG_ACTION = 'auth.change_password';
24
+ const LOG_DETAILS = { ip: req.ip, uid: details.uid ?? null };
23
25
 
24
26
  if (typeof details !== 'object' || typeof details.uid !== 'string' || typeof details.password !== 'string' || typeof details.new_password !== 'string') {
25
- env.logRef.push({ action: 'change_password', success: false, code: 'invalid_details', ip: req.ip, date: new Date() });
27
+ env.log.error(LOG_ACTION, 'invalid_details', LOG_DETAILS);
26
28
  res.status(400).send('Bad Request'); // Bad Request
27
29
  return;
28
30
  }
29
31
  if (details.new_password.length < 8 || details.new_password.includes(' ') || !/[0-9]/.test(details.new_password) || !/[a-z]/.test(details.new_password) || !/[A-Z]/.test(details.new_password)) {
30
- env.logRef.push({ action: 'change_password', success: false, code: 'new_password_denied', ip: req.ip, date: new Date(), uid: details.uid });
32
+ env.log.error(LOG_ACTION, 'new_password_denied', LOG_DETAILS);
31
33
  const err = 'Invalid new password, must be at least 8 characters and contain a combination of numbers and letters (both lower and uppercase)';
32
34
  res.status(422).send(err);// Unprocessable Entity
33
35
  return;
@@ -71,10 +73,11 @@ export const addRoute = (env: RouteInitEnvironment) => {
71
73
  return user; // Update db
72
74
  });
73
75
 
76
+ env.log.event(LOG_ACTION, LOG_DETAILS);
74
77
  res.send({ access_token: publicAccessToken }); // Client must use this new access token from now on
75
78
  }
76
79
  catch(err) {
77
- env.logRef.push({ action: 'change_pwd', success: false, code: err.code, ip: req.ip, date: new Date(), uid: details.uid });
80
+ env.log.error(LOG_ACTION, err.code, LOG_DETAILS);
78
81
  if (err.code) {
79
82
  sendBadRequestError(res, err);
80
83
  }
@@ -15,30 +15,32 @@ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>
15
15
  export const addRoute = (env: RouteInitEnvironment) => {
16
16
  env.app.post(`/auth/${env.db.name}/delete`, async (req: Request, res) => {
17
17
  let details = req.body;
18
+ const LOG_ACTION = 'auth.delete';
19
+ const LOG_DETAILS = { ip: req.ip, uid: req.user?.uid ?? null, delete_uid: details.uid };
18
20
 
19
21
  if (!req.user) {
20
- env.logRef.push({ action: 'delete', success: false, code: 'unauthenticated_delete', delete_uid: details.uid, ip: req.ip, date: new Date() });
22
+ env.log.error(LOG_ACTION, 'unauthenticated_delete', LOG_DETAILS);
21
23
  return sendNotAuthenticatedError(res, 'unauthenticated_delete', 'You are not authorized to perform this operation, your attempt has been logged');
22
24
  }
23
25
 
24
26
  if (req.user.uid !== 'admin' && details.uid !== req.user.uid) {
25
- env.logRef.push({ action: 'delete', success: false, code: 'unauthorized_delete', auth_uid: req.user.uid, delete_uid: details.uid, ip: req.ip, date: new Date() });
27
+ env.log.error(LOG_ACTION, 'unauthorized_delete', LOG_DETAILS);
26
28
  return sendUnauthorizedError(res, 'unauthorized_delete', 'You are not authorized to perform this operation, your attempt has been logged');
27
29
  }
28
30
 
29
31
  const uid = details.uid ?? req.user.uid;
30
32
  if (uid === 'admin') {
31
- env.logRef.push({ action: 'delete', success: false, code: 'unauthorized_delete', auth_uid: req.user.uid, delete_uid: details.uid, ip: req.ip, date: new Date() });
33
+ env.log.error(LOG_ACTION, 'unauthorized_delete', LOG_DETAILS);
32
34
  return sendUnauthorizedError(res, 'unauthorized_delete', 'The admin account cannot be deleted, your attempt has been logged');
33
35
  }
34
36
 
35
37
  try {
36
38
  await env.authRef.child(uid).remove();
37
- env.logRef.push({ action: 'delete', success: true, auth_uid: req.user.uid, delete_uid: details.uid, ip: req.ip, date: new Date() });
39
+ env.log.event(LOG_ACTION, LOG_DETAILS);
38
40
  res.send('Farewell');
39
41
  }
40
42
  catch (err) {
41
- env.logRef.push({ action: 'delete', success: false, code: 'unexpected', auth_uid: req.user.uid, delete_uid: details.uid, ip: req.ip, date: new Date() });
43
+ env.log.error(LOG_ACTION, 'unexpected', { ...LOG_DETAILS, message: (err instanceof Error && err.message) ?? err.toString() });
42
44
  sendUnexpectedError(res, err);
43
45
  }
44
46
  });
@@ -21,6 +21,9 @@ export const addRoute = (env: RouteInitEnvironment) => {
21
21
  env.app.post(`/auth/${env.db.name}/forgot_password`, async (req: Request, res) => {
22
22
 
23
23
  const details = req.body;
24
+ const LOG_ACTION = 'auth.forgot_password';
25
+ const LOG_DETAILS = { ip: req.ip, uid: req.user?.uid ?? null, email: details.email };
26
+
24
27
  try {
25
28
  if (!env.config.email || typeof env.config.email.send !== 'function') {
26
29
  throw new ForgotPasswordError('server_email_config', 'Server email settings have not been configured');
@@ -51,15 +54,16 @@ export const addRoute = (env: RouteInitEnvironment) => {
51
54
  displayName: user.display_name
52
55
  }
53
56
  };
54
- await Promise.all([
55
- env.config.email.send(request),
56
- snap.ref.update({ password_reset_code: user.password_reset_code })
57
- ])
58
- env.logRef.push({ action: 'forgot_password', success: true, email: details.email, ip: req.ip, date: new Date() });
57
+
58
+ await snap.ref.update({ password_reset_code: user.password_reset_code });
59
+ await env.config.email.send(request).catch(err => {
60
+ env.log.error(LOG_ACTION + '.email', 'unexpected', { ...LOG_DETAILS, request }, err);
61
+ });
62
+ env.log.event(LOG_ACTION, LOG_DETAILS);
59
63
  res.send('OK');
60
64
  }
61
65
  catch (err) {
62
- env.logRef.push({ action: 'forgot_password', success: false, code: err.code || 'unexpected', message: err.code ? null : err.message, email: details.email, ip: req.ip, date: new Date() });
66
+ env.log.error(LOG_ACTION, err.code || 'unexpected', { ...LOG_DETAILS, message: (err instanceof Error && err.message) ?? err.toString() });
63
67
  if (err.code) {
64
68
  sendBadRequestError(res, err);
65
69
  }
@@ -71,13 +71,16 @@ export const addRoute = (env: RouteInitEnvironment) => {
71
71
  env.app.post(`/auth/${env.db.name}/reset_password`, async (req: Request, res) => {
72
72
 
73
73
  const details = req.body;
74
+ const LOG_ACTION = 'auth.reset_password';
75
+ const LOG_DETAILS = { ip: req.ip, uid: req.user?.uid ?? null };
76
+
74
77
  try {
75
78
  const user = await resetPassword(req.ip, details.code, details.password);
76
- env.logRef.push({ action: 'reset_password', success: true, ip: req.ip, date: new Date(), uid: user.uid });
79
+ env.log.event(LOG_ACTION, { ...LOG_DETAILS, reset_uid: user.uid });
77
80
  res.send('OK');
78
81
  }
79
82
  catch (err) {
80
- env.logRef.push({ action: 'reset_password', success: false, code: err.code, message: err.message, ip: req.ip, date: new Date(), uid: req.user?.uid ?? null });
83
+ env.log.error(LOG_ACTION, err.code ?? 'unexpected', { ...LOG_DETAILS, message: (err instanceof Error && err.message) ?? err.toString() });
81
84
  if (err.code) {
82
85
  sendBadRequestError(res, err);
83
86
  }
@@ -12,6 +12,9 @@ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>
12
12
  export const addRoute = (env: RouteInitEnvironment) => {
13
13
  env.app.post(`/auth/${env.db.name}/signout`, async (req: Request, res) => {
14
14
 
15
+ const LOG_ACTION = 'auth.signout';
16
+ const LOG_DETAILS = { ip: req.ip, uid: req.user?.uid ?? null };
17
+
15
18
  try {
16
19
  if (req.user) {
17
20
  const client = typeof req.body.client_id === 'string' ? env.clients.get(req.body.client_id) : null; // NEW in AceBaseClient v0.9.4
@@ -46,12 +49,12 @@ export const addRoute = (env: RouteInitEnvironment) => {
46
49
  return user;
47
50
  });
48
51
 
49
- env.logRef.push({ action: 'signout', success: true, uid: req.user.uid, ip: req.ip, date: new Date() });
52
+ env.log.event(LOG_ACTION, LOG_DETAILS);
50
53
  }
51
54
  res.send('Bye!');
52
55
  }
53
56
  catch(err) {
54
- env.logRef.push({ action: 'signout', success: false, code: 'unexpected', message: err.message, uid: req.user.uid, ip: req.ip, date: new Date() });
57
+ env.log.error(LOG_ACTION, 'unexpected', { ...LOG_DETAILS, message: err instanceof Error ? err.message : err.toString() });
55
58
  sendUnexpectedError(res, err);
56
59
  }
57
60
 
@@ -5,7 +5,7 @@ import { createPasswordHash } from '../shared/password';
5
5
  import { ID } from 'acebase-core';
6
6
  import { AceBaseUserSignupEmailRequest } from '../shared/email';
7
7
  import { createPublicAccessToken, createSignedPublicToken } from '../shared/tokens';
8
- import { sendUnexpectedError } from '../shared/error';
8
+ import { sendUnauthorizedError, sendUnexpectedError } from '../shared/error';
9
9
 
10
10
  export class SignupError extends Error {
11
11
  constructor(public code: 'admin_only'|'conflict'|'email_conflict'|'username_conflict'|'missing_details'|'invalid_email'|'invalid_username'|'invalid_display_name'|'invalid_password'|'invalid_picture'|'invalid_settings', message: string) {
@@ -35,10 +35,12 @@ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>
35
35
 
36
36
  export const addRoute = (env: RouteInitEnvironment) => {
37
37
  env.app.post(`/auth/${env.db.name}/signup`, async (req: Request, res) => {
38
- if (!env.config.auth.allowUserSignup && (!req.user || req.user.username !== 'admin')) {
39
- env.logRef.push({ action: 'signup', success: false, code: 'user_signup_disabled', ip: req.ip, date: new Date() });
40
- res.statusCode = 403; // Forbidden
41
- return res.send({ code: 'admin_only', message: 'Only admin is allowed to create users' });
38
+ const LOG_ACTION = 'auth.signup';
39
+ const LOG_DETAILS = { ip: req.ip, uid: req.user?.uid ?? null };
40
+
41
+ if (!env.config.auth.allowUserSignup && req.user?.uid !== 'admin') {
42
+ env.log.error(LOG_ACTION, 'user_signup_disabled', LOG_DETAILS);
43
+ return sendUnauthorizedError(res, 'admin_only', 'Only admin is allowed to create users');
42
44
  }
43
45
 
44
46
  // Create user if it doesn't exist yet.
@@ -82,13 +84,13 @@ export const addRoute = (env: RouteInitEnvironment) => {
82
84
  }
83
85
 
84
86
  if (err === emailExistsError || err === usernameExistsError) {
85
- env.logRef.push({ action: 'signup', success: false, code: 'conflict', ip: req.ip, date: new Date(), username: details.username, email: details.email });
87
+ env.log.error(LOG_ACTION, 'conflict', { ...LOG_DETAILS, username: details.username, email: details.email });
86
88
  res.statusCode = 409; // conflict
87
89
  return res.send(emailOrUsernameExistsError);
88
90
  }
89
91
  else if (err) {
90
92
  // Log failure
91
- env.logRef.push({ action: 'signup', success: false, code: err.code, ip: req.ip, date: new Date() });
93
+ env.log.error(LOG_ACTION, err.code ?? 'unexpected', LOG_DETAILS);
92
94
  res.statusCode = 422; // Unprocessable Entity
93
95
  return res.send(err);
94
96
  }
@@ -116,9 +118,10 @@ export const addRoute = (env: RouteInitEnvironment) => {
116
118
 
117
119
  const userRef = await env.authRef.push(user);
118
120
  user.uid = userRef.key;
121
+ LOG_DETAILS.uid = user.uid;
119
122
 
120
123
  // Log success
121
- env.logRef.push({ action: 'signup', success: true, ip: req.ip, date: new Date(), uid: user.uid });
124
+ env.log.event(LOG_ACTION, LOG_DETAILS);
122
125
 
123
126
  // Cache the user
124
127
  env.authCache.set(user.uid, user);
@@ -141,7 +144,7 @@ export const addRoute = (env: RouteInitEnvironment) => {
141
144
  };
142
145
 
143
146
  env.config.email?.send(request).catch(err => {
144
- env.logRef.push({ action: 'signup_email', success: false, code: 'unexpected', ip: req.ip, date: new Date(), error: err.message, request });
147
+ env.log.error(LOG_ACTION + '.email', 'unexpected', { ...LOG_DETAILS, request }, err);
145
148
  });
146
149
 
147
150
  // Return the positive news
@@ -152,7 +155,7 @@ export const addRoute = (env: RouteInitEnvironment) => {
152
155
  });
153
156
  }
154
157
  catch (err) {
155
- env.logRef.push({ action: 'signup', success: false, code: 'unexpected', ip: req.ip, date: new Date(), error: err.message, username: details.username, email: details.email });
158
+ env.log.error(LOG_ACTION, 'unexpected', { ...LOG_DETAILS, message: err instanceof Error ? err.message : err.toString(), username: details.username, email: details.email });
156
159
  sendUnexpectedError(res, err);
157
160
  }
158
161
  });
@@ -36,16 +36,18 @@ export const addRoute = (env: RouteInitEnvironment) => {
36
36
  env.app.post(`/auth/${env.db.name}/update`, async (req: Request, res) => {
37
37
 
38
38
  let details = req.body;
39
+ const LOG_ACTION = 'auth.update';
40
+ const LOG_DETAILS = { ip: req.ip, uid: req.user?.uid ?? null, update_uid: details.uid ?? null };
39
41
 
40
42
  if (!req.user) {
41
- env.logRef.push({ action: 'update', success: false, code: 'unauthenticated_update', update_uid: details.uid, ip: req.ip, date: new Date() });
43
+ env.log.error(LOG_ACTION, 'unauthenticated_update', LOG_DETAILS);
42
44
  return sendNotAuthenticatedError(res, 'unauthenticated_update', 'Sign in to change details');
43
45
  }
44
46
 
45
47
  const uid = details.uid || req.user.uid;
46
48
 
47
49
  if (req.user.uid !== 'admin' && (uid !== req.user.uid || typeof details.is_disabled === 'boolean')) {
48
- env.logRef.push({ action: 'update', success: false, code: 'unauthorized_update', auth_uid: req.user.uid, update_uid: details.uid, ip: req.ip, date: new Date() });
50
+ env.log.error(LOG_ACTION, 'unauthorized_update', LOG_DETAILS);
49
51
  return sendUnauthorizedError(res, 'unauthorized_update', 'You are not authorized to perform this update. This attempt has been logged.');
50
52
  }
51
53
 
@@ -80,7 +82,7 @@ export const addRoute = (env: RouteInitEnvironment) => {
80
82
 
81
83
  if (err) {
82
84
  // Log failure
83
- env.logRef.push({ action: 'update', success: false, code: err.code, auth_uid: req.user.uid, update_uid: uid, ip: req.ip, date: new Date() });
85
+ env.log.error(LOG_ACTION, err.code, LOG_DETAILS);
84
86
  res.status(422).send(err); // Unprocessable Entity
85
87
  return;
86
88
  }
@@ -108,7 +110,7 @@ export const addRoute = (env: RouteInitEnvironment) => {
108
110
  });
109
111
  if (!isValidSettings(user.settings)) {
110
112
  err = invalidSettingsError;
111
- env.logRef.push({ action: 'update', success: false, code: 'too_many_settings', auth_uid: req.user.uid, update_uid: details.uid, ip: req.ip, date: new Date() });
113
+ env.log.error(LOG_ACTION, 'too_many_settings', LOG_DETAILS);
112
114
  res.statusCode = 422; // Unprocessable Entity
113
115
  res.send(err);
114
116
  return;
@@ -131,14 +133,14 @@ export const addRoute = (env: RouteInitEnvironment) => {
131
133
 
132
134
  // All known errors except user_not_found will have been sent already
133
135
  if (err.code === 'user_not_found') {
134
- env.logRef.push({ action: 'update', success: false, code: err.code, auth_uid: req.user.uid, update_uid: details.uid, ip: req.ip, date: new Date() });
136
+ env.log.error(LOG_ACTION, err.code, LOG_DETAILS);
135
137
 
136
138
  res.statusCode = 404; // Not Found
137
139
  res.send(err);
138
140
  }
139
141
  else {
140
142
  // Unexpected
141
- env.logRef.push({ action: 'update', success: false, code: err.code || 'unexpected', message: err.message, auth_uid: req.user.uid, update_uid: details.uid, ip: req.ip, date: new Date() });
143
+ env.log.error(LOG_ACTION, err.code ?? 'unexpected', LOG_DETAILS, err);
142
144
  sendUnexpectedError(res, err);
143
145
  }
144
146
  }
@@ -21,7 +21,12 @@ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>
21
21
  */
22
22
  export const addRoute = (env: RouteInitEnvironment) => {
23
23
 
24
+ const LOG_ACTION = 'auth.verify_email';
25
+
24
26
  const verifyEmailAddress = async (clientIp: string, code: string) => {
27
+
28
+ const LOG_DETAILS = { ip: clientIp, uid: null };
29
+
25
30
  try {
26
31
  var verification = parseSignedPublicToken(code, env.tokenSalt);
27
32
  }
@@ -29,8 +34,10 @@ export const addRoute = (env: RouteInitEnvironment) => {
29
34
  throw new VerifyEmailError('invalid_code', err.message);
30
35
  }
31
36
 
37
+ LOG_DETAILS.uid = verification.uid;
32
38
  const snap = await env.authRef.child(verification.uid).get();
33
- if (!snap.exists()) {
39
+ if (!snap.exists()) {
40
+ env.log.error(LOG_ACTION, 'unknown_user', LOG_DETAILS);
34
41
  throw new VerifyEmailError('unknown_user', 'Unknown user');
35
42
  }
36
43
  const user: DbUserAccountDetails = snap.val();
@@ -40,22 +47,23 @@ export const addRoute = (env: RouteInitEnvironment) => {
40
47
  // Mark account as verified
41
48
  await snap.ref.update({ email_verified: true });
42
49
 
43
- env.logRef.push({ action: 'verify_email', success: true, ip: clientIp, date: new Date(), uid: user.uid });
50
+ env.log.event(LOG_ACTION, LOG_DETAILS);
44
51
  };
45
52
 
46
53
  env.app.post(`/auth/${env.db.name}/verify_email`, async (req: Request, res) => {
47
54
 
48
55
  const details = req.body;
56
+
49
57
  try {
50
58
  await verifyEmailAddress(req.ip, details.code);
51
59
  res.send('OK');
52
60
  }
53
61
  catch (err) {
54
- env.logRef.push({ action: 'verify_email', success: false, code: err.code, message: err.message, ip: req.ip, date: new Date(), uid: req.user?.uid ?? null });
55
62
  if (err.code) {
56
63
  sendBadRequestError(res, err);
57
64
  }
58
65
  else {
66
+ env.log.error(LOG_ACTION, 'unexpected', { ip: req.ip, message: err.message, verificaion_code: details.code });
59
67
  sendUnexpectedError(res, err);
60
68
  }
61
69
  }
@@ -1,5 +1,6 @@
1
+ import adminOnly from '../middleware/admin-only';
1
2
  import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
- import { sendError, sendUnauthorizedError } from '../shared/error';
3
+ import { sendError } from '../shared/error';
3
4
  import { Response } from '../shared/http';
4
5
 
5
6
  export type FullTextIndexOptions = {
@@ -51,10 +52,6 @@ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>
51
52
  export const addRoute = (env: RouteInitEnvironment) => {
52
53
 
53
54
  const handleRequest = async (req: Request, res: Response) => {
54
- if (!req.user || req.user.username !== 'admin') {
55
- return sendUnauthorizedError(res, 'admin_only', 'only admin can perform index operations');
56
- }
57
-
58
55
  try {
59
56
  const data = req.body;
60
57
  await env.db.indexes.create(data.path, data.key, data.options);
@@ -66,7 +63,7 @@ export const addRoute = (env: RouteInitEnvironment) => {
66
63
  }
67
64
  };
68
65
 
69
- env.app.post(`/index/${env.db.name}`, async (req: RouteRequest<any, ResponseBody, RequestBody & { action: 'create'} >, res) => {
66
+ env.app.post(`/index/${env.db.name}`, adminOnly(env), async (req: RouteRequest<any, ResponseBody, RequestBody & { action: 'create'} >, res) => {
70
67
  // Legacy endpoint that was designed to handle multiple actions
71
68
  // The only action ever implemented was 'create', so we'll handle that here
72
69
  if (req.body?.action !== 'create') {
@@ -75,7 +72,7 @@ export const addRoute = (env: RouteInitEnvironment) => {
75
72
  handleRequest(req, res);
76
73
  });
77
74
 
78
- env.app.post(`/index/${env.db.name}/create`, async (req: Request, res) => {
75
+ env.app.post(`/index/${env.db.name}/create`, adminOnly(env), async (req: Request, res) => {
79
76
  // New dedicated create endpoint
80
77
  handleRequest(req, res);
81
78
  });
@@ -1,5 +1,6 @@
1
+ import adminOnly from '../middleware/admin-only';
1
2
  import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
- import { sendError, sendUnauthorizedError } from '../shared/error';
3
+ import { sendError } from '../shared/error';
3
4
 
4
5
  export type RequestQuery = null;
5
6
  export type RequestBody = {
@@ -13,12 +14,8 @@ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>
13
14
 
14
15
  export const addRoute = (env: RouteInitEnvironment) => {
15
16
 
16
- env.app.post(`/index/${env.db.name}/delete`, async (req: Request, res) => {
17
+ env.app.post(`/index/${env.db.name}/delete`, adminOnly(env), async (req: Request, res) => {
17
18
  // Delete an index
18
- if (!req.user || req.user.username !== 'admin') {
19
- return sendUnauthorizedError(res, 'admin_only', 'only admin can perform index operations');
20
- }
21
-
22
19
  try {
23
20
  const data = req.body;
24
21
  if (!data.fileName) {
@@ -1,5 +1,6 @@
1
+ import adminOnly from '../middleware/admin-only';
1
2
  import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
- import { sendError, sendUnauthorizedError } from '../shared/error';
3
+ import { sendError } from '../shared/error';
3
4
 
4
5
  export interface PublicDataIndex {
5
6
  path: string;
@@ -19,12 +20,8 @@ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>
19
20
 
20
21
  export const addRoute = (env: RouteInitEnvironment) => {
21
22
 
22
- env.app.get(`/index/${env.db.name}`, async (req: Request, res) => {
23
+ env.app.get(`/index/${env.db.name}`, adminOnly(env), async (req: Request, res) => {
23
24
  // Get all indexes
24
- if (!req.user || req.user.username !== 'admin') {
25
- return sendUnauthorizedError(res, 'admin_only', 'only admin can perform index operations');
26
- }
27
-
28
25
  try {
29
26
  const indexes = await env.db.indexes.get();
30
27
  res.contentType('application/json').send(indexes.map(index => {
@@ -34,7 +34,7 @@ export type ResponseBody = {
34
34
  count: number;
35
35
  list: any[]
36
36
  },
37
- map: any
37
+ map?: any
38
38
  };
39
39
  export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
40
40
 
@@ -21,16 +21,13 @@ export const addRoute = (env: RouteInitEnvironment) => {
21
21
 
22
22
  env.app.get(`/reflect/${env.db.name}/*`, async (req: Request, res) => {
23
23
  // Reflection API
24
- // if (!req.user || req.user.username !== 'admin') {
25
- // return sendUnauthorizedError(res, 'admin_only', 'only admin can use reflection api');
26
- // }
27
24
  const path = req.path.slice(env.db.name.length + 10);
28
25
  const access = env.rules.userHasAccess(req.user, path, false);
29
26
  if (!access.allow) {
30
27
  return sendUnauthorizedError(res, access.code, access.message);
31
28
  }
32
29
  const impersonatedAccess = {
33
- uid: (!req.user || req.user.username !== 'admin') ? null : req.query.impersonate,
30
+ uid: req.user?.uid !== 'admin' ? null : req.query.impersonate,
34
31
  read: {
35
32
  allow: false,
36
33
  error: null
@@ -1,5 +1,6 @@
1
+ import adminOnly from '../middleware/admin-only';
1
2
  import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
- import { sendError, sendUnauthorizedError } from '../shared/error';
3
+ import { sendError } from '../shared/error';
3
4
 
4
5
  export type RequestQuery = null;
5
6
  export type RequestBody = null;
@@ -11,11 +12,8 @@ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>
11
12
 
12
13
  export const addRoute = (env: RouteInitEnvironment) => {
13
14
 
14
- env.app.get(`/schema/${env.db.name}/*`, async (req: Request, res) => {
15
+ env.app.get(`/schema/${env.db.name}/*`, adminOnly(env), async (req: Request, res) => {
15
16
  // Get defined schema for a specifc path
16
- if (!req.user || req.user.username !== 'admin') {
17
- return sendUnauthorizedError(res, 'admin_only', 'only admin can perform schema operations');
18
- }
19
17
  try {
20
18
  const path = req.path.slice(env.db.name.length + 9);
21
19
  const schema = await env.db.schema.get(path);
@@ -1,5 +1,6 @@
1
+ import adminOnly from '../middleware/admin-only';
1
2
  import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
- import { sendError, sendUnauthorizedError } from '../shared/error';
3
+ import { sendError } from '../shared/error';
3
4
 
4
5
  export type RequestQuery = null;
5
6
  export type RequestBody = {
@@ -15,12 +16,8 @@ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>
15
16
 
16
17
  export const addRoute = (env: RouteInitEnvironment) => {
17
18
 
18
- env.app.post(`/schema/${env.db.name}`, async (req: Request, res) => {
19
+ env.app.post(`/schema/${env.db.name}`, adminOnly(env), async (req: Request, res) => {
19
20
  // defines a schema
20
- if (!req.user || req.user.username !== 'admin') {
21
- return sendUnauthorizedError(res, 'admin_only', 'only admin can perform schema operations');
22
- }
23
-
24
21
  try {
25
22
  const data = req.body;
26
23
  const { path, schema } = data;
@@ -1,8 +1,9 @@
1
1
  import { ISchemaCheckResult, SchemaDefinition, Transport } from 'acebase-core';
2
2
  import type { IAceBaseSchemaInfo } from 'acebase-core/src/api';
3
3
  import type { SerializedValue } from 'acebase-core/types/transport';
4
+ import adminOnly from '../middleware/admin-only';
4
5
  import { RouteInitEnvironment, RouteRequest } from '../shared/env';
5
- import { sendError, sendUnauthorizedError } from '../shared/error';
6
+ import { sendError } from '../shared/error';
6
7
 
7
8
  export type RequestQuery = null;
8
9
  export type RequestBody = {
@@ -19,12 +20,8 @@ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>
19
20
 
20
21
  export const addRoute = (env: RouteInitEnvironment) => {
21
22
 
22
- env.app.post(`/schema/${env.db.name}/test`, async (req: Request, res) => {
23
+ env.app.post(`/schema/${env.db.name}/test`, adminOnly(env), async (req: Request, res) => {
23
24
  // tests a schema
24
- if (!req.user || req.user.username !== 'admin') {
25
- return sendUnauthorizedError(res, 'admin_only', 'only admin can perform schema operations');
26
- }
27
-
28
25
  try {
29
26
  const data = req.body;
30
27
  if (typeof data.value?.val === 'undefined' || !['string','object','undefined'].includes(typeof data.value?.map)) {
@@ -1,5 +1,6 @@
1
+ import adminOnly from '../middleware/admin-only';
1
2
  import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
- import { sendError, sendUnauthorizedError } from '../shared/error';
3
+ import { sendError } from '../shared/error';
3
4
 
4
5
  export type RequestQuery = null;
5
6
  export type RequestBody = null;
@@ -10,11 +11,8 @@ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>
10
11
 
11
12
  export const addRoute = (env: RouteInitEnvironment) => {
12
13
 
13
- env.app.get(`/schema/${env.db.name}`, async (req: Request, res) => {
14
+ env.app.get(`/schema/${env.db.name}`, adminOnly(env), async (req: Request, res) => {
14
15
  // Get all defined schemas
15
- if (!req.user || req.user.username !== 'admin') {
16
- return sendUnauthorizedError(res, 'admin_only', 'only admin can perform schema operations');
17
- }
18
16
  try {
19
17
  const schemas = await env.db.schema.all();
20
18
  res.contentType('application/json').send(schemas.map(schema => ({
@@ -23,10 +23,14 @@ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>
23
23
  export const addRoute = (env: RouteInitEnvironment) => {
24
24
 
25
25
  env.app.put(`/data/${env.db.name}/*`, async (req: Request, res) => {
26
- // Set data
26
+
27
27
  const path = req.path.slice(env.db.name.length + 7);
28
+ const LOG_ACTION = 'data.set';
29
+ const LOG_DETAILS = { ip: req.ip, uid: req.user?.uid ?? null, path };
30
+
28
31
  const access = env.rules.userHasAccess(req.user, path, true);
29
32
  if (!access.allow) {
33
+ env.log.error(LOG_ACTION, 'unauthorized', { ...LOG_DETAILS, rule_code: access.code, rule_path: access.rulePath ?? null, rule_error: access.details?.message ?? null });
30
34
  return sendUnauthorizedError(res, access.code, access.message);
31
35
  }
32
36
 
@@ -52,23 +56,27 @@ export const addRoute = (env: RouteInitEnvironment) => {
52
56
  .context(req.context)
53
57
  .set(val);
54
58
 
59
+ // NEW: add cursor to response context, which was added to the request context in `acebase_cursor` if transaction logging is enabled
60
+ const returnContext = { acebase_cursor: req.context.acebase_cursor };
61
+ res.setHeader('AceBase-Context', JSON.stringify(returnContext) );
62
+
55
63
  res.send({ success: true });
56
64
  }
57
- catch(err) {
65
+ catch (err) {
58
66
  if (err instanceof SchemaValidationError) {
59
- env.logRef?.push({ action: 'set_data', success: false, code: 'schema_validation_failed', path, error: err.reason, ip: req.ip, uid: req.user?.uid ?? null });
67
+ env.log.error(LOG_ACTION, 'schema_validation_failed', { ...LOG_DETAILS, reason: err.reason });
60
68
  res.status(422).send({ code: 'schema_validation_failed', message: err.message });
61
69
  }
62
70
  else if (err instanceof SetDataError) {
63
- env.logRef?.push({ action: 'set_data', success: false, code: err.code, path, ip: req.ip, uid: req.user?.uid ?? null });
71
+ env.log.error(LOG_ACTION, err.code, { ...LOG_DETAILS, message: err.message });
64
72
  sendBadRequestError(res, err);
65
73
  }
66
74
  else {
67
75
  env.debug.error(`failed to set "${path}":`, err);
68
- env.logRef?.push({ action: 'set_data', success: false, code: 'unknown_error', path, error: err.message, ip: req.ip, uid: req.user?.uid ?? null });
76
+ env.log.error(LOG_ACTION, 'unexpected', LOG_DETAILS, err);
69
77
  sendError(res, err);
70
78
  }
71
- };
79
+ }
72
80
  });
73
81
 
74
82
  };
@@ -24,7 +24,7 @@
24
24
  description: Contextual info about the database operation (must be valid JSON). This info is included in event notifications sent to clients watching data at this or child paths
25
25
  schema:
26
26
  type: string
27
- example: {}
27
+ example: '{}'
28
28
  requestBody:
29
29
  description: serialized value to store in the database
30
30
  content:
@@ -36,6 +36,12 @@
36
36
  description: Returns "200 OK" when the database operation succeeded
37
37
  content:
38
38
  'application/json':
39
+ headers:
40
+ 'AceBase-Context':
41
+ description: Returns contextual information, such as the `acebase_cursor` if transaction logging is enabled on the server.
42
+ schema:
43
+ type: string
44
+ example: '{ "acebase_cursor": "l3lf2iwd000109mgdn0d6pqt" }'
39
45
  schema:
40
46
  type: object
41
47
  properties:
@@ -65,7 +65,7 @@ export const addRoute = (env: RouteInitEnvironment) => {
65
65
  res.contentType('application/json');
66
66
 
67
67
  const serialized = Transport.serialize2(result.changes);
68
- res.send(serialized);
68
+ res.send(serialized as ValueChange[]);
69
69
  }
70
70
  catch(err) {
71
71
  sendError(res, err);
@@ -65,7 +65,7 @@ export const addRoute = (env: RouteInitEnvironment) => {
65
65
  res.contentType('application/json');
66
66
 
67
67
  const serialized = Transport.serialize2(result.mutations);
68
- res.send(serialized);
68
+ res.send(serialized as ValueMutation[]);
69
69
  }
70
70
  catch(err) {
71
71
  sendError(res, err);