acebase-server 1.11.0 → 1.13.1

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 (342) hide show
  1. package/.vscode/launch.json +24 -0
  2. package/dist/cjs/index.d.ts +1 -0
  3. package/dist/cjs/logger.js +74 -0
  4. package/dist/cjs/middleware/admin-only.js +29 -0
  5. package/dist/cjs/middleware/user.js +4 -4
  6. package/dist/cjs/routes/auth-change-password.js +7 -4
  7. package/dist/cjs/routes/auth-delete.js +9 -7
  8. package/dist/cjs/routes/auth-forgot-password.js +9 -6
  9. package/dist/cjs/routes/auth-reset-password.js +5 -3
  10. package/dist/cjs/routes/auth-signout.js +6 -4
  11. package/dist/cjs/routes/auth-signup.js +17 -15
  12. package/dist/cjs/routes/auth-update.js +9 -6
  13. package/dist/cjs/routes/auth-verify-email.js +6 -3
  14. package/dist/cjs/routes/data-index-create.js +3 -5
  15. package/dist/cjs/routes/data-index-delete.js +2 -4
  16. package/dist/cjs/routes/data-index-list.js +2 -4
  17. package/dist/cjs/routes/data-reflect.js +2 -4
  18. package/dist/cjs/routes/data-schema-get.js +2 -4
  19. package/dist/cjs/routes/data-schema-set.js +2 -4
  20. package/dist/cjs/routes/data-schema-test.js +2 -4
  21. package/dist/cjs/routes/data-schemas-list.js +2 -4
  22. package/dist/cjs/routes/data-set.js +8 -7
  23. package/dist/cjs/routes/data-transaction.js +15 -8
  24. package/dist/cjs/routes/data-update.js +8 -6
  25. package/dist/cjs/routes/meta-logs.js +50 -0
  26. package/dist/cjs/routes/meta.js +3 -0
  27. package/dist/cjs/routes/oauth2-signin.js +9 -6
  28. package/dist/cjs/server.js +3 -1
  29. package/dist/cjs/shared/rootpath.js +2 -0
  30. package/dist/cjs/shared/signin.js +8 -3
  31. package/dist/cjs/start.js +3 -0
  32. package/dist/cjs/websocket/index.js +42 -23
  33. package/dist/esm/index.d.ts +1 -0
  34. package/dist/esm/logger.js +52 -0
  35. package/dist/esm/middleware/admin-only.js +25 -0
  36. package/dist/esm/middleware/user.js +4 -4
  37. package/dist/esm/routes/auth-change-password.js +6 -3
  38. package/dist/esm/routes/auth-delete.js +7 -5
  39. package/dist/esm/routes/auth-forgot-password.js +8 -6
  40. package/dist/esm/routes/auth-reset-password.js +4 -2
  41. package/dist/esm/routes/auth-signout.js +4 -2
  42. package/dist/esm/routes/auth-signup.js +12 -10
  43. package/dist/esm/routes/auth-update.js +8 -6
  44. package/dist/esm/routes/auth-verify-email.js +6 -2
  45. package/dist/esm/routes/data-index-create.js +4 -6
  46. package/dist/esm/routes/data-index-delete.js +3 -5
  47. package/dist/esm/routes/data-index-list.js +3 -5
  48. package/dist/esm/routes/data-reflect.js +1 -4
  49. package/dist/esm/routes/data-schema-get.js +3 -5
  50. package/dist/esm/routes/data-schema-set.js +3 -5
  51. package/dist/esm/routes/data-schema-test.js +3 -5
  52. package/dist/esm/routes/data-schemas-list.js +3 -5
  53. package/dist/esm/routes/data-set.js +6 -5
  54. package/dist/esm/routes/data-transaction.js +12 -5
  55. package/dist/esm/routes/data-update.js +6 -4
  56. package/dist/esm/routes/meta-logs.js +36 -0
  57. package/dist/esm/routes/meta.js +3 -0
  58. package/dist/esm/routes/oauth2-signin.js +8 -5
  59. package/dist/esm/server.js +3 -1
  60. package/dist/esm/shared/rootpath.js +2 -0
  61. package/dist/esm/shared/signin.js +7 -3
  62. package/dist/esm/start.js +3 -0
  63. package/dist/esm/websocket/index.js +37 -22
  64. package/dist/types/logger.d.ts +35 -0
  65. package/dist/types/middleware/admin-only.d.ts +19 -0
  66. package/dist/types/routes/meta-logs.d.ts +20 -0
  67. package/dist/types/rules.d.ts +2 -2
  68. package/dist/types/shared/env.d.ts +3 -1
  69. package/dist/types/shared/signin.d.ts +1 -1
  70. package/dist/types/websocket/index.d.ts +4 -0
  71. package/package.json +5 -5
  72. package/webmanager/acebase-client-browser.min.js +16 -16
  73. package/create-package-files +0 -12
  74. package/dist/cjs/auth.js.map +0 -1
  75. package/dist/cjs/cluster.js.map +0 -1
  76. package/dist/cjs/index.js.map +0 -1
  77. package/dist/cjs/middleware/404.js.map +0 -1
  78. package/dist/cjs/middleware/cache.js.map +0 -1
  79. package/dist/cjs/middleware/connection.js.map +0 -1
  80. package/dist/cjs/middleware/context.js.map +0 -1
  81. package/dist/cjs/middleware/cors.js.map +0 -1
  82. package/dist/cjs/middleware/swagger.js.map +0 -1
  83. package/dist/cjs/middleware/user.js.map +0 -1
  84. package/dist/cjs/oauth-providers/dropbox.js.map +0 -1
  85. package/dist/cjs/oauth-providers/facebook.js.map +0 -1
  86. package/dist/cjs/oauth-providers/google.js.map +0 -1
  87. package/dist/cjs/oauth-providers/index.js.map +0 -1
  88. package/dist/cjs/oauth-providers/instagram.js.map +0 -1
  89. package/dist/cjs/oauth-providers/oauth-provider.js.map +0 -1
  90. package/dist/cjs/oauth-providers/spotify.js.map +0 -1
  91. package/dist/cjs/routes/auth-change-password.js.map +0 -1
  92. package/dist/cjs/routes/auth-delete.js.map +0 -1
  93. package/dist/cjs/routes/auth-forgot-password.js.map +0 -1
  94. package/dist/cjs/routes/auth-reset-password.js.map +0 -1
  95. package/dist/cjs/routes/auth-signin.js.map +0 -1
  96. package/dist/cjs/routes/auth-signout.js.map +0 -1
  97. package/dist/cjs/routes/auth-signup.js.map +0 -1
  98. package/dist/cjs/routes/auth-state.js.map +0 -1
  99. package/dist/cjs/routes/auth-update.js.map +0 -1
  100. package/dist/cjs/routes/auth-verify-email.js.map +0 -1
  101. package/dist/cjs/routes/auth.js.map +0 -1
  102. package/dist/cjs/routes/data-exists.js.map +0 -1
  103. package/dist/cjs/routes/data-export.js.map +0 -1
  104. package/dist/cjs/routes/data-get.js.map +0 -1
  105. package/dist/cjs/routes/data-import.js.map +0 -1
  106. package/dist/cjs/routes/data-index-create.js.map +0 -1
  107. package/dist/cjs/routes/data-index-delete.js.map +0 -1
  108. package/dist/cjs/routes/data-index-list.js.map +0 -1
  109. package/dist/cjs/routes/data-query.js.map +0 -1
  110. package/dist/cjs/routes/data-reflect.js.map +0 -1
  111. package/dist/cjs/routes/data-schema-get.js.map +0 -1
  112. package/dist/cjs/routes/data-schema-set.js.map +0 -1
  113. package/dist/cjs/routes/data-schema-test.js.map +0 -1
  114. package/dist/cjs/routes/data-schemas-list.js.map +0 -1
  115. package/dist/cjs/routes/data-set.js.map +0 -1
  116. package/dist/cjs/routes/data-sync-changes.js.map +0 -1
  117. package/dist/cjs/routes/data-sync-mutations.js.map +0 -1
  118. package/dist/cjs/routes/data-transaction.js.map +0 -1
  119. package/dist/cjs/routes/data-update.js.map +0 -1
  120. package/dist/cjs/routes/data.js.map +0 -1
  121. package/dist/cjs/routes/docs.js.map +0 -1
  122. package/dist/cjs/routes/meta-info.js.map +0 -1
  123. package/dist/cjs/routes/meta-ping.js.map +0 -1
  124. package/dist/cjs/routes/meta-stats.js.map +0 -1
  125. package/dist/cjs/routes/meta.js.map +0 -1
  126. package/dist/cjs/routes/oauth2-init.js.map +0 -1
  127. package/dist/cjs/routes/oauth2-refresh.js.map +0 -1
  128. package/dist/cjs/routes/oauth2-signin.js.map +0 -1
  129. package/dist/cjs/routes/webmanager.js.map +0 -1
  130. package/dist/cjs/rules.js.map +0 -1
  131. package/dist/cjs/schema/user.js.map +0 -1
  132. package/dist/cjs/server.js.map +0 -1
  133. package/dist/cjs/settings/email.js.map +0 -1
  134. package/dist/cjs/settings/index.js.map +0 -1
  135. package/dist/cjs/shared/clients.js.map +0 -1
  136. package/dist/cjs/shared/email.js.map +0 -1
  137. package/dist/cjs/shared/env.js.map +0 -1
  138. package/dist/cjs/shared/error.js.map +0 -1
  139. package/dist/cjs/shared/http.js.map +0 -1
  140. package/dist/cjs/shared/password.js.map +0 -1
  141. package/dist/cjs/shared/rootpath.js.map +0 -1
  142. package/dist/cjs/shared/signin.js.map +0 -1
  143. package/dist/cjs/shared/simple-fetch.js.map +0 -1
  144. package/dist/cjs/shared/tokens.js.map +0 -1
  145. package/dist/cjs/shared/validate.js.map +0 -1
  146. package/dist/cjs/start.js.map +0 -1
  147. package/dist/cjs/test.js.map +0 -1
  148. package/dist/cjs/websocket/index.js.map +0 -1
  149. package/dist/cjs/websocket/manager.js.map +0 -1
  150. package/dist/cjs/websocket/socket.io.js.map +0 -1
  151. package/dist/esm/auth.js.map +0 -1
  152. package/dist/esm/cluster.js.map +0 -1
  153. package/dist/esm/index.js.map +0 -1
  154. package/dist/esm/middleware/404.js.map +0 -1
  155. package/dist/esm/middleware/cache.js.map +0 -1
  156. package/dist/esm/middleware/connection.js.map +0 -1
  157. package/dist/esm/middleware/context.js.map +0 -1
  158. package/dist/esm/middleware/cors.js.map +0 -1
  159. package/dist/esm/middleware/swagger.js.map +0 -1
  160. package/dist/esm/middleware/user.js.map +0 -1
  161. package/dist/esm/oauth-providers/dropbox.js.map +0 -1
  162. package/dist/esm/oauth-providers/facebook.js.map +0 -1
  163. package/dist/esm/oauth-providers/google.js.map +0 -1
  164. package/dist/esm/oauth-providers/index.js.map +0 -1
  165. package/dist/esm/oauth-providers/instagram.js.map +0 -1
  166. package/dist/esm/oauth-providers/oauth-provider.js.map +0 -1
  167. package/dist/esm/oauth-providers/spotify.js.map +0 -1
  168. package/dist/esm/routes/auth-change-password.js.map +0 -1
  169. package/dist/esm/routes/auth-delete.js.map +0 -1
  170. package/dist/esm/routes/auth-forgot-password.js.map +0 -1
  171. package/dist/esm/routes/auth-reset-password.js.map +0 -1
  172. package/dist/esm/routes/auth-signin.js.map +0 -1
  173. package/dist/esm/routes/auth-signout.js.map +0 -1
  174. package/dist/esm/routes/auth-signup.js.map +0 -1
  175. package/dist/esm/routes/auth-state.js.map +0 -1
  176. package/dist/esm/routes/auth-update.js.map +0 -1
  177. package/dist/esm/routes/auth-verify-email.js.map +0 -1
  178. package/dist/esm/routes/auth.js.map +0 -1
  179. package/dist/esm/routes/data-exists.js.map +0 -1
  180. package/dist/esm/routes/data-export.js.map +0 -1
  181. package/dist/esm/routes/data-get.js.map +0 -1
  182. package/dist/esm/routes/data-import.js.map +0 -1
  183. package/dist/esm/routes/data-index-create.js.map +0 -1
  184. package/dist/esm/routes/data-index-delete.js.map +0 -1
  185. package/dist/esm/routes/data-index-list.js.map +0 -1
  186. package/dist/esm/routes/data-query.js.map +0 -1
  187. package/dist/esm/routes/data-reflect.js.map +0 -1
  188. package/dist/esm/routes/data-schema-get.js.map +0 -1
  189. package/dist/esm/routes/data-schema-set.js.map +0 -1
  190. package/dist/esm/routes/data-schema-test.js.map +0 -1
  191. package/dist/esm/routes/data-schemas-list.js.map +0 -1
  192. package/dist/esm/routes/data-set.js.map +0 -1
  193. package/dist/esm/routes/data-sync-changes.js.map +0 -1
  194. package/dist/esm/routes/data-sync-mutations.js.map +0 -1
  195. package/dist/esm/routes/data-transaction.js.map +0 -1
  196. package/dist/esm/routes/data-update.js.map +0 -1
  197. package/dist/esm/routes/data.js.map +0 -1
  198. package/dist/esm/routes/docs.js.map +0 -1
  199. package/dist/esm/routes/meta-info.js.map +0 -1
  200. package/dist/esm/routes/meta-ping.js.map +0 -1
  201. package/dist/esm/routes/meta-stats.js.map +0 -1
  202. package/dist/esm/routes/meta.js.map +0 -1
  203. package/dist/esm/routes/oauth2-init.js.map +0 -1
  204. package/dist/esm/routes/oauth2-refresh.js.map +0 -1
  205. package/dist/esm/routes/oauth2-signin.js.map +0 -1
  206. package/dist/esm/routes/webmanager.js.map +0 -1
  207. package/dist/esm/rules.js.map +0 -1
  208. package/dist/esm/schema/user.js.map +0 -1
  209. package/dist/esm/server.js.map +0 -1
  210. package/dist/esm/settings/email.js.map +0 -1
  211. package/dist/esm/settings/index.js.map +0 -1
  212. package/dist/esm/shared/clients.js.map +0 -1
  213. package/dist/esm/shared/email.js.map +0 -1
  214. package/dist/esm/shared/env.js.map +0 -1
  215. package/dist/esm/shared/error.js.map +0 -1
  216. package/dist/esm/shared/http.js.map +0 -1
  217. package/dist/esm/shared/password.js.map +0 -1
  218. package/dist/esm/shared/rootpath.js.map +0 -1
  219. package/dist/esm/shared/signin.js.map +0 -1
  220. package/dist/esm/shared/simple-fetch.js.map +0 -1
  221. package/dist/esm/shared/tokens.js.map +0 -1
  222. package/dist/esm/shared/validate.js.map +0 -1
  223. package/dist/esm/start.js.map +0 -1
  224. package/dist/esm/test.js.map +0 -1
  225. package/dist/esm/websocket/index.js.map +0 -1
  226. package/dist/esm/websocket/manager.js.map +0 -1
  227. package/dist/esm/websocket/socket.io.js.map +0 -1
  228. package/src/auth.ts +0 -87
  229. package/src/cluster.ts +0 -62
  230. package/src/index.ts +0 -4
  231. package/src/middleware/404.ts +0 -13
  232. package/src/middleware/cache.ts +0 -15
  233. package/src/middleware/connection.ts +0 -48
  234. package/src/middleware/context.ts +0 -23
  235. package/src/middleware/cors.ts +0 -49
  236. package/src/middleware/swagger.ts +0 -19
  237. package/src/middleware/user.ts +0 -51
  238. package/src/oauth-providers/dropbox.ts +0 -144
  239. package/src/oauth-providers/facebook.ts +0 -103
  240. package/src/oauth-providers/google.ts +0 -147
  241. package/src/oauth-providers/index.ts +0 -21
  242. package/src/oauth-providers/instagram.ts +0 -98
  243. package/src/oauth-providers/oauth-provider.ts +0 -65
  244. package/src/oauth-providers/spotify.ts +0 -127
  245. package/src/placeholder.d.ts +0 -12
  246. package/src/routes/auth-change-password.ts +0 -89
  247. package/src/routes/auth-change-password.yaml +0 -74
  248. package/src/routes/auth-delete.ts +0 -47
  249. package/src/routes/auth-delete.yaml +0 -78
  250. package/src/routes/auth-forgot-password.ts +0 -73
  251. package/src/routes/auth-forgot-password.yaml +0 -50
  252. package/src/routes/auth-reset-password.ts +0 -93
  253. package/src/routes/auth-reset-password.yaml +0 -54
  254. package/src/routes/auth-signin.ts +0 -55
  255. package/src/routes/auth-signin.yaml +0 -130
  256. package/src/routes/auth-signout.ts +0 -61
  257. package/src/routes/auth-signout.yaml +0 -46
  258. package/src/routes/auth-signup.ts +0 -161
  259. package/src/routes/auth-signup.yaml +0 -136
  260. package/src/routes/auth-state.ts +0 -20
  261. package/src/routes/auth-state.yaml +0 -29
  262. package/src/routes/auth-update.ts +0 -147
  263. package/src/routes/auth-update.yaml +0 -152
  264. package/src/routes/auth-verify-email.ts +0 -67
  265. package/src/routes/auth-verify-email.yaml +0 -53
  266. package/src/routes/auth.ts +0 -67
  267. package/src/routes/data-exists.ts +0 -31
  268. package/src/routes/data-exists.yaml +0 -44
  269. package/src/routes/data-export.ts +0 -51
  270. package/src/routes/data-export.yaml +0 -64
  271. package/src/routes/data-get.ts +0 -68
  272. package/src/routes/data-get.yaml +0 -54
  273. package/src/routes/data-import.ts +0 -56
  274. package/src/routes/data-import.yaml +0 -75
  275. package/src/routes/data-index-create.ts +0 -85
  276. package/src/routes/data-index-create.yaml +0 -105
  277. package/src/routes/data-index-delete.ts +0 -39
  278. package/src/routes/data-index-delete.yaml +0 -51
  279. package/src/routes/data-index-list.ts +0 -42
  280. package/src/routes/data-index-list.yaml +0 -80
  281. package/src/routes/data-query.ts +0 -97
  282. package/src/routes/data-query.yaml +0 -166
  283. package/src/routes/data-reflect.ts +0 -94
  284. package/src/routes/data-reflect.yaml +0 -124
  285. package/src/routes/data-schema-get.ts +0 -38
  286. package/src/routes/data-schema-get.yaml +0 -53
  287. package/src/routes/data-schema-set.ts +0 -38
  288. package/src/routes/data-schema-set.yaml +0 -60
  289. package/src/routes/data-schema-test.ts +0 -53
  290. package/src/routes/data-schema-test.yaml +0 -66
  291. package/src/routes/data-schemas-list.ts +0 -33
  292. package/src/routes/data-schemas-list.yaml +0 -41
  293. package/src/routes/data-set.ts +0 -80
  294. package/src/routes/data-set.yaml +0 -77
  295. package/src/routes/data-sync-changes.ts +0 -78
  296. package/src/routes/data-sync-changes.yaml +0 -67
  297. package/src/routes/data-sync-mutations.ts +0 -78
  298. package/src/routes/data-sync-mutations.yaml +0 -67
  299. package/src/routes/data-transaction-finish.yaml +0 -82
  300. package/src/routes/data-transaction-start.yaml +0 -58
  301. package/src/routes/data-transaction.ts +0 -159
  302. package/src/routes/data-update.ts +0 -81
  303. package/src/routes/data-update.yaml +0 -77
  304. package/src/routes/data.ts +0 -79
  305. package/src/routes/docs.ts +0 -249
  306. package/src/routes/meta-info.ts +0 -80
  307. package/src/routes/meta-info.yaml +0 -41
  308. package/src/routes/meta-ping.ts +0 -15
  309. package/src/routes/meta-ping.yaml +0 -23
  310. package/src/routes/meta-stats.ts +0 -31
  311. package/src/routes/meta-stats.yaml +0 -41
  312. package/src/routes/meta.ts +0 -18
  313. package/src/routes/oauth2-init.ts +0 -44
  314. package/src/routes/oauth2-init.yaml +0 -63
  315. package/src/routes/oauth2-refresh.ts +0 -39
  316. package/src/routes/oauth2-refresh.yaml +0 -65
  317. package/src/routes/oauth2-signin.ts +0 -282
  318. package/src/routes/oauth2-signin.yaml +0 -66
  319. package/src/routes/webmanager.ts +0 -29
  320. package/src/rules.ts +0 -196
  321. package/src/schema/user.ts +0 -99
  322. package/src/server.ts +0 -418
  323. package/src/settings/email.ts +0 -18
  324. package/src/settings/index.ts +0 -241
  325. package/src/shared/clients.ts +0 -31
  326. package/src/shared/email.ts +0 -33
  327. package/src/shared/env.ts +0 -38
  328. package/src/shared/error.ts +0 -37
  329. package/src/shared/http.ts +0 -26
  330. package/src/shared/password.ts +0 -41
  331. package/src/shared/rootpath.ts +0 -15
  332. package/src/shared/signin.ts +0 -143
  333. package/src/shared/simple-fetch.ts +0 -65
  334. package/src/shared/tokens.ts +0 -77
  335. package/src/shared/validate.ts +0 -53
  336. package/src/start.ts +0 -45
  337. package/src/test.ts +0 -10
  338. package/src/websocket/index.ts +0 -320
  339. package/src/websocket/manager.ts +0 -46
  340. package/src/websocket/socket.io.ts +0 -90
  341. package/tsconfig-cjs.json +0 -10
  342. package/tsconfig.json +0 -21
@@ -1,54 +0,0 @@
1
- /auth/{dbname}/reset_password:
2
- post:
3
- tags:
4
- - auth
5
- summary: Completes a password reset
6
- description: Completes a password reset request for a user account with a code sent to the email address by the `forgot_password` endpoint
7
- parameters:
8
- - name: dbname
9
- in: path
10
- description: name of the database
11
- required: true
12
- schema:
13
- type: string
14
- example: mydb
15
- requestBody:
16
- description: verification object
17
- content:
18
- 'application/json':
19
- schema:
20
- type: object
21
- properties:
22
- code:
23
- type: string
24
- description: Password reset code that was sent to the user's email address
25
- password:
26
- type: string
27
- description: New password to set on the account
28
- required:
29
- - code
30
- - password
31
- responses:
32
- 200:
33
- description: If the password reset is successful, returns the string `"OK"`
34
- content:
35
- 'text/plain':
36
- schema:
37
- type: 'string'
38
- value: OK
39
- description: The string `"OK"`
40
- 400:
41
- description: Returns a `"401 Bad Request"` if the code sent with the request is invalid, or the new password doesn't meet the requirements
42
- content:
43
- 'application/json':
44
- schema:
45
- $ref: '#/components/schemas/Error'
46
- example:
47
- code: invalid_code
48
- message: Invalid token
49
- 500:
50
- description: An unexpected error occurred
51
- content:
52
- 'application/json':
53
- schema:
54
- $ref: '#/components/schemas/UnexpectedError'
@@ -1,55 +0,0 @@
1
- import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
- import { AceBaseUser, getPublicAccountDetails } from '../schema/user';
3
- import { sendNotAuthenticatedError, sendUnexpectedError } from '../shared/error';
4
- import { createPublicAccessToken } from '../shared/tokens';
5
- import { signIn, SignInCredentials } from '../shared/signin';
6
-
7
- export type RequestQuery = {};
8
- export type RequestBody = { client_id?: string } & (
9
- { method: 'token'; access_token: string } |
10
- { method: 'email'; email: string; password: string } |
11
- { method: 'account', username: string, password: string }
12
- );
13
- export type ResponseBody = {
14
- access_token: string;
15
- user: AceBaseUser
16
- };
17
-
18
- export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
19
-
20
- export const addRoute = (env: RouteInitEnvironment) => {
21
- if (!env.config.auth.enabled) {
22
- throw new Error('Authentication not enabled in the server settings');
23
- }
24
-
25
- env.app.post(`/auth/${env.db.name}/signin`, async (req: Request, res) => {
26
-
27
- const details = req.body;
28
- const clientId = details.client_id || null; // NEW in AceBaseClient v0.9.4
29
-
30
- try {
31
- const user = await signIn(details as SignInCredentials, env, req);
32
- if (typeof clientId === 'string' && env.clients.has(clientId)) {
33
- const client = env.clients.get(clientId);
34
- client.user = user; // Bind user to client socket
35
- }
36
- res.send({
37
- access_token: createPublicAccessToken(user.uid, req.ip, user.access_token, env.tokenSalt),
38
- user: getPublicAccountDetails(user)
39
- });
40
- }
41
- catch (err) {
42
-
43
- if (typeof err.code === 'string') {
44
- // Authentication error
45
- return sendNotAuthenticatedError(res, err.code, err.message);
46
- }
47
-
48
- // Unexpected error
49
- return sendUnexpectedError(res, err);
50
- }
51
-
52
- });
53
- };
54
-
55
- export default addRoute;
@@ -1,130 +0,0 @@
1
- /auth/{dbname}/signin:
2
- post:
3
- tags:
4
- - auth
5
- summary: Sign in a user
6
- description: Signs in an existing user
7
- parameters:
8
- - name: dbname
9
- in: path
10
- description: name of the database
11
- required: true
12
- schema:
13
- type: string
14
- example: mydb
15
- requestBody:
16
- description: sign in details
17
- content:
18
- 'application/json':
19
- schema:
20
- oneOf:
21
- - type: object
22
- properties:
23
- client_id:
24
- description: ID of the connected websocket
25
- type: string
26
- method:
27
- description: Method of authentication (email)
28
- type: string
29
- value: email
30
- email:
31
- description: User email address
32
- type: string
33
- password:
34
- description: Password
35
- type: string
36
- format: password
37
- required:
38
- - method
39
- - email
40
- - password
41
- example:
42
- method: email
43
- email: user@example.com
44
- password: sup3rs3cr3t
45
- - type: object
46
- properties:
47
- client_id:
48
- description: ID of the connected websocket
49
- type: string
50
- method:
51
- description: Method of authentication (account)
52
- type: string
53
- value: account
54
- username:
55
- description: Username
56
- type: string
57
- password:
58
- description: Password
59
- type: string
60
- format: password
61
- required:
62
- - method
63
- - username
64
- - password
65
- example:
66
- method: username
67
- username: user
68
- password: sup3rs3cr3t
69
- - type: object
70
- properties:
71
- client_id:
72
- type: string
73
- description: ID of the connected websocket
74
- method:
75
- type: string
76
- value: token
77
- description: Method of authentication (token)
78
- access_token:
79
- type: string
80
- description: Previously acquired access token to sign in with
81
- required:
82
- - method
83
- - access_token
84
- example:
85
- method: token
86
- access_token: bewufh387f3fyubqwekrjbcqwkuiec7gq3euyfbqwkuyebqjk..
87
- responses:
88
- 200:
89
- description: When signin succeeds, it returns an object with the result
90
- content:
91
- 'application/json':
92
- schema:
93
- type: object
94
- properties:
95
- access_token:
96
- description: The access token that provides access to API calls that require authentication. This access token should be added to the Authorization header of those requests. The token is allowed to be cached by the client to sign in witht the token method later
97
- type: string
98
- example: ewufh387f3fyubqwekrjbcqwkuiec7gq3euyfbqwkuyebqjk..
99
- user:
100
- $ref: '#/components/schemas/User'
101
- 401:
102
- description: When the sent request details are incorrect, this "401 Unauthorized" is returned
103
- content:
104
- 'application/json':
105
- schema:
106
- type: object
107
- properties:
108
- code:
109
- type: string
110
- description: The exact error code
111
- enum:
112
- - invalid_token
113
- - not_found
114
- - duplicate
115
- - token_mismatch
116
- - wrong_password
117
- example: not_found
118
- message:
119
- type: string
120
- description: Description of the error
121
- example: Incorrect email
122
- example:
123
- code: wrong_password
124
- message: Incorrect password
125
- 500:
126
- description: An unenexpected error occurred on the server
127
- content:
128
- 'application/json':
129
- schema:
130
- $ref: '#/components/schemas/UnexpectedError'
@@ -1,61 +0,0 @@
1
- import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
- import { DbUserAccountDetails } from '../schema/user';
3
- import { sendUnexpectedError } from '../shared/error';
4
-
5
- export type RequestQuery = {};
6
- export type RequestBody = { client_id?: string } & {
7
- everywhere: boolean
8
- };
9
- export type ResponseBody = 'Bye!' | { code: string; message: string };
10
- export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
11
-
12
- export const addRoute = (env: RouteInitEnvironment) => {
13
- env.app.post(`/auth/${env.db.name}/signout`, async (req: Request, res) => {
14
-
15
- try {
16
- if (req.user) {
17
- const client = typeof req.body.client_id === 'string' ? env.clients.get(req.body.client_id) : null; // NEW in AceBaseClient v0.9.4
18
- if (client) {
19
- // Remove user binding from client socket
20
- client.user = null;
21
- }
22
-
23
- const signOutEverywhere = typeof req.body === 'object' && req.body.everywhere === true; // NEW in AceBaseClient v0.9.14
24
- if (signOutEverywhere) {
25
- // Remove token from cache
26
- env.authCache.remove(req.user.uid);
27
-
28
- // Remove user binding from all clients signed in with current user
29
- for (let client of env.clients.values()) {
30
- if (client.user?.uid === req.user.uid) {
31
- client.user = null;
32
- }
33
- }
34
- }
35
-
36
- // Remove token from user's auth node
37
- await env.authRef.child(req.user.uid).transaction(snap => {
38
- if (!snap.exists()) { return; }
39
-
40
- const user: DbUserAccountDetails = snap.val();
41
- if (signOutEverywhere) {
42
- user.access_token = null;
43
- }
44
- user.last_signout = new Date();
45
- user.last_signout_ip = req.ip;
46
- return user;
47
- });
48
-
49
- env.logRef.push({ action: 'signout', success: true, uid: req.user.uid, ip: req.ip, date: new Date() });
50
- }
51
- res.send('Bye!');
52
- }
53
- 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() });
55
- sendUnexpectedError(res, err);
56
- }
57
-
58
- });
59
- };
60
-
61
- export default addRoute;
@@ -1,46 +0,0 @@
1
- /auth/{dbname}/signout:
2
- post:
3
- tags:
4
- - auth
5
- summary: Sign out current user
6
- description: Signs out the currently signed in user
7
- parameters:
8
- - name: dbname
9
- in: path
10
- description: name of the database
11
- required: true
12
- schema:
13
- type: string
14
- example: mydb
15
- requestBody:
16
- description: Sign out details
17
- content:
18
- 'application/json':
19
- schema:
20
- type: object
21
- properties:
22
- client_id:
23
- type: string
24
- description: ID of the connected websocket
25
- everywhere:
26
- type: boolean
27
- description: Whether the user should sign out on ALL clients
28
- example:
29
- client_id: x8WIv7-mJelg7on_ALbx
30
- everywhere: false
31
- responses:
32
- 200:
33
- description: Returns `"Bye!"` if signout is successful
34
- content:
35
- 'text/plain':
36
- schema:
37
- type: string
38
- value: Bye!
39
- example: Bye!
40
- 500:
41
- description: Returns an object describing an unexpected error
42
- content:
43
- 'application/json':
44
- schema:
45
- $ref: '#/components/schemas/Error'
46
-
@@ -1,161 +0,0 @@
1
- import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
- import { AceBaseUser, DbUserAccountDetails, getPublicAccountDetails, UserProfilePicture } from '../schema/user';
3
- import { emailExistsError, emailOrUsernameExistsError, invalidDisplayNameError, invalidEmailError, invalidPasswordError, invalidPictureError, invalidSettingsError, invalidUsernameError, isValidDisplayName, isValidEmail, isValidNewEmailAddress, isValidNewUsername, isValidPassword, isValidPicture, isValidSettings, isValidUsername, usernameExistsError } from '../shared/validate';
4
- import { createPasswordHash } from '../shared/password';
5
- import { ID } from 'acebase-core';
6
- import { AceBaseUserSignupEmailRequest } from '../shared/email';
7
- import { createPublicAccessToken, createSignedPublicToken } from '../shared/tokens';
8
- import { sendUnexpectedError } from '../shared/error';
9
-
10
- export class SignupError extends Error {
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) {
12
- super(message);
13
- }
14
- }
15
-
16
- export type RequestQuery = {};
17
- export type RequestBody = {
18
- username: string;
19
- email: string;
20
- password: string;
21
- displayName?: string;
22
- display_name?: string;
23
- picture?: UserProfilePicture;
24
- settings: {
25
- [name: string]: string|number|boolean
26
- };
27
- } & (
28
- // Allow both spellings of display name. display_name is used in the db, displayName in public user detail server responses.
29
- // displayName is preferred and documented in the OpenAPI docs
30
- { displayName: string; } | { display_name: string; }
31
- );
32
-
33
- export type ResponseBody = { access_token: string; user: AceBaseUser } | { code: SignupError['code']; message: string };
34
- export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
35
-
36
- export const addRoute = (env: RouteInitEnvironment) => {
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' });
42
- }
43
-
44
- // Create user if it doesn't exist yet.
45
- // TODO: Rate-limit nr of signups per IP to prevent abuse
46
-
47
- const details = req.body;
48
-
49
- if (typeof details.display_name === 'string' && typeof details.displayName !== 'string') {
50
- // Allow display_name to be sent also (which is used in update endpoint)
51
- details.displayName = details.display_name;
52
- }
53
-
54
- // Check if sent details are ok
55
- let err: { code: SignupError['code'], message: string };
56
- if (!details.username && !details.email) {
57
- err = { code: 'missing_details', message: 'No username or email provided' };
58
- }
59
- else if (details.email && !isValidEmail(details.email)) {
60
- err = invalidEmailError;
61
- }
62
- else if (details.email && !await isValidNewEmailAddress(env.authRef, details.email)) {
63
- err = emailExistsError;
64
- }
65
- else if (details.username && !isValidUsername(details.username)) {
66
- err = invalidUsernameError;
67
- }
68
- else if (details.username && !await isValidNewUsername(env.authRef, details.username)) {
69
- err = usernameExistsError;
70
- }
71
- else if (!isValidDisplayName(details.displayName)) {
72
- err = invalidDisplayNameError;
73
- }
74
- else if (!isValidPassword(details.password)) {
75
- err = invalidPasswordError;
76
- }
77
- else if (!isValidSettings(details.settings)) {
78
- err = invalidSettingsError;
79
- }
80
- else if (details.picture && !isValidPicture(details.picture)) {
81
- err = invalidPictureError;
82
- }
83
-
84
- 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 });
86
- res.statusCode = 409; // conflict
87
- return res.send(emailOrUsernameExistsError);
88
- }
89
- else if (err) {
90
- // Log failure
91
- env.logRef.push({ action: 'signup', success: false, code: err.code, ip: req.ip, date: new Date() });
92
- res.statusCode = 422; // Unprocessable Entity
93
- return res.send(err);
94
- }
95
-
96
- try {
97
- // Ok, create user
98
- let pwd = createPasswordHash(details.password);
99
- const user: DbUserAccountDetails = {
100
- uid: null,
101
- username: details.username ?? null,
102
- email: details.email ?? null,
103
- email_verified: false,
104
- display_name: details.displayName,
105
- password: pwd.hash,
106
- password_salt: pwd.salt,
107
- created: new Date(),
108
- created_ip: req.ip,
109
- access_token: ID.generate(),
110
- access_token_created: new Date(),
111
- last_signin: new Date(),
112
- last_signin_ip: req.ip,
113
- picture: details.picture ?? null,
114
- settings: details.settings ?? {}
115
- };
116
-
117
- const userRef = await env.authRef.push(user);
118
- user.uid = userRef.key;
119
-
120
- // Log success
121
- env.logRef.push({ action: 'signup', success: true, ip: req.ip, date: new Date(), uid: user.uid });
122
-
123
- // Cache the user
124
- env.authCache.set(user.uid, user);
125
-
126
- // Request welcome e-mail to be sent
127
- const request: AceBaseUserSignupEmailRequest = {
128
- type: 'user_signup',
129
- user: {
130
- uid: user.uid,
131
- username: user.username,
132
- email: user.email,
133
- displayName: user.display_name,
134
- settings: user.settings
135
- },
136
- date: user.created,
137
- ip: user.created_ip,
138
- provider: 'acebase',
139
- activationCode: createSignedPublicToken({ uid: user.uid }, env.tokenSalt),
140
- emailVerified: false
141
- };
142
-
143
- 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 });
145
- });
146
-
147
- // Return the positive news
148
- const isAdmin = req.user && req.user.uid === 'admin';
149
- res.send({
150
- access_token: isAdmin ? '' : createPublicAccessToken(user.uid, req.ip, user.access_token, env.tokenSalt),
151
- user: getPublicAccountDetails(user)
152
- });
153
- }
154
- 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 });
156
- sendUnexpectedError(res, err);
157
- }
158
- });
159
- };
160
-
161
- export default addRoute;
@@ -1,136 +0,0 @@
1
- /auth/{dbname}/signup:
2
- post:
3
- tags:
4
- - auth
5
- summary: Create a new user
6
- description: Signs up a new user (must be enabled in the server config)
7
- parameters:
8
- - name: dbname
9
- in: path
10
- description: name of the database
11
- required: true
12
- schema:
13
- type: string
14
- example: mydb
15
- requestBody:
16
- description: new user details
17
- content:
18
- 'application/json':
19
- schema:
20
- type: object
21
- properties:
22
- username:
23
- type: string
24
- description: Requested username (optional if `email` provided)
25
- email:
26
- type: string
27
- description: Email address (optional if `username` provided)
28
- displayName:
29
- type: string
30
- description: Name of the user for public displaying purposes. Consider this a real name, alias or handle
31
- password:
32
- type: string
33
- format: password
34
- description: Password to set for the account
35
- picture:
36
- type: object
37
- description: Profile picture
38
- properties:
39
- url:
40
- type: string
41
- width:
42
- type: number
43
- height:
44
- type: number
45
- example:
46
- url: https://my.profile.pic/me.jpg
47
- width: 500
48
- height: 500
49
- settings:
50
- type: object
51
- otherProperties: true
52
- desciption: (optional) miscellanious other info to store with the user account
53
- required:
54
- - username
55
- - email
56
- - displayName
57
- - password
58
- example:
59
- email: user@example.com
60
- displayName: Real Name
61
- password: sup3rs3cr3t
62
- responses:
63
- 200:
64
- description: When signup succeeds, it returns an object with the result
65
- content:
66
- 'application/json':
67
- schema:
68
- type: object
69
- properties:
70
- access_token:
71
- description: The access token that provides access to API calls that require authentication. This access token should be added to the Authorization header of those requests. The token is allowed to be cached by the client to sign in witht the token method later
72
- type: string
73
- example: ewufh387f3fyubqwekrjbcqwkuiec7gq3euyfbqwkuyebqjk..
74
- user:
75
- $ref: '#/components/schemas/User'
76
- 403:
77
- description: If user signup is disabled in the server config, only the admin user can create new accounts and `"403 Forbidden"` is returned
78
- content:
79
- 'application/json':
80
- schema:
81
- type: object
82
- properties:
83
- code:
84
- type: string
85
- value: admin_only
86
- message:
87
- type: string
88
- value: Only admin is allowed to create users
89
- example:
90
- code: admin_only
91
- message: Only admin is allowed to create users
92
- 409:
93
- description: An account with the same username or email address exists already
94
- content:
95
- 'application/json':
96
- schema:
97
- type: object
98
- properties:
99
- code:
100
- type: string
101
- value: conflict
102
- message:
103
- type: string
104
- value: Account with username and/or email already exists
105
- 422:
106
- description: When the sent request details are incorrect, `"422 Unprocessable Entity"` is returned
107
- content:
108
- 'application/json':
109
- schema:
110
- type: object
111
- properties:
112
- code:
113
- type: string
114
- description: The exact error code
115
- enum:
116
- - missing_details
117
- - invalid_email
118
- - invalid_username
119
- - invalid_display_name
120
- - invalid_password
121
- - invalid_settings
122
- - invalid_picture
123
- example: missing_details
124
- message:
125
- type: string
126
- description: Description of the error
127
- example: No username or email provided
128
- example:
129
- code: invalid_password
130
- message: Invalid password, must be at least 8 characters and cannot contain spaces
131
- 500:
132
- description: An unenexpected error occurred on the server
133
- content:
134
- 'application/json':
135
- schema:
136
- $ref: '#/components/schemas/UnexpectedError'
@@ -1,20 +0,0 @@
1
- import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
- import { AceBaseUser, getPublicAccountDetails } from '../schema/user';
3
-
4
- export type RequestQuery = {};
5
- export type RequestBody = {};
6
- export type ResponseBody = { signed_in: false } | { signed_in: true; user: AceBaseUser };
7
- export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
8
-
9
- export const addRoute = (env: RouteInitEnvironment) => {
10
- env.app.get(`/auth/${env.db.name}/state`, async (req: Request, res) => {
11
- if (req.user) {
12
- res.send({ signed_in: true, user: getPublicAccountDetails(req.user) });
13
- }
14
- else {
15
- res.send({ signed_in: false });
16
- }
17
- });
18
- };
19
-
20
- export default addRoute;