acebase-server 1.10.1 → 1.13.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 (378) hide show
  1. package/.vscode/launch.json +24 -0
  2. package/dist/cjs/index.d.ts +1 -0
  3. package/dist/cjs/index.js +16 -0
  4. package/dist/cjs/logger.js +74 -0
  5. package/dist/cjs/middleware/admin-only.js +29 -0
  6. package/dist/cjs/middleware/user.js +4 -4
  7. package/dist/cjs/oauth-providers/dropbox.js +3 -2
  8. package/dist/cjs/oauth-providers/facebook.js +3 -2
  9. package/dist/cjs/oauth-providers/google.js +3 -2
  10. package/dist/cjs/oauth-providers/instagram.js +3 -2
  11. package/dist/cjs/oauth-providers/oauth-provider.js +23 -0
  12. package/dist/cjs/oauth-providers/spotify.js +3 -2
  13. package/dist/cjs/routes/auth-change-password.js +7 -4
  14. package/dist/cjs/routes/auth-delete.js +9 -7
  15. package/dist/cjs/routes/auth-forgot-password.js +9 -6
  16. package/dist/cjs/routes/auth-reset-password.js +5 -3
  17. package/dist/cjs/routes/auth-signout.js +6 -4
  18. package/dist/cjs/routes/auth-signup.js +17 -15
  19. package/dist/cjs/routes/auth-update.js +9 -6
  20. package/dist/cjs/routes/auth-verify-email.js +6 -3
  21. package/dist/cjs/routes/data-index-create.js +3 -5
  22. package/dist/cjs/routes/data-index-delete.js +2 -4
  23. package/dist/cjs/routes/data-index-list.js +2 -4
  24. package/dist/cjs/routes/data-reflect.js +2 -4
  25. package/dist/cjs/routes/data-schema-get.js +2 -4
  26. package/dist/cjs/routes/data-schema-set.js +2 -4
  27. package/dist/cjs/routes/data-schema-test.js +2 -4
  28. package/dist/cjs/routes/data-schemas-list.js +2 -4
  29. package/dist/cjs/routes/data-set.js +11 -7
  30. package/dist/cjs/routes/data-transaction.js +30 -10
  31. package/dist/cjs/routes/data-update.js +11 -6
  32. package/dist/cjs/routes/meta-logs.js +50 -0
  33. package/dist/cjs/routes/meta.js +3 -0
  34. package/dist/cjs/routes/oauth2-signin.js +15 -11
  35. package/dist/cjs/rules.js +5 -5
  36. package/dist/cjs/server.js +6 -4
  37. package/dist/cjs/settings/index.js +6 -7
  38. package/dist/cjs/shared/rootpath.js +2 -0
  39. package/dist/cjs/shared/signin.js +8 -3
  40. package/dist/cjs/start.js +3 -0
  41. package/dist/cjs/websocket/index.js +43 -24
  42. package/dist/cjs/websocket/socket.io.js +8 -11
  43. package/dist/esm/index.d.ts +1 -0
  44. package/dist/esm/index.js +2 -0
  45. package/dist/esm/logger.js +52 -0
  46. package/dist/esm/middleware/admin-only.js +25 -0
  47. package/dist/esm/middleware/user.js +4 -4
  48. package/dist/esm/oauth-providers/dropbox.js +3 -2
  49. package/dist/esm/oauth-providers/facebook.js +3 -2
  50. package/dist/esm/oauth-providers/google.js +3 -2
  51. package/dist/esm/oauth-providers/instagram.js +3 -2
  52. package/dist/esm/oauth-providers/oauth-provider.js +21 -1
  53. package/dist/esm/oauth-providers/spotify.js +3 -2
  54. package/dist/esm/routes/auth-change-password.js +6 -3
  55. package/dist/esm/routes/auth-delete.js +7 -5
  56. package/dist/esm/routes/auth-forgot-password.js +8 -6
  57. package/dist/esm/routes/auth-reset-password.js +4 -2
  58. package/dist/esm/routes/auth-signout.js +4 -2
  59. package/dist/esm/routes/auth-signup.js +12 -10
  60. package/dist/esm/routes/auth-update.js +8 -6
  61. package/dist/esm/routes/auth-verify-email.js +6 -2
  62. package/dist/esm/routes/data-index-create.js +4 -6
  63. package/dist/esm/routes/data-index-delete.js +3 -5
  64. package/dist/esm/routes/data-index-list.js +3 -5
  65. package/dist/esm/routes/data-reflect.js +1 -4
  66. package/dist/esm/routes/data-schema-get.js +3 -5
  67. package/dist/esm/routes/data-schema-set.js +3 -5
  68. package/dist/esm/routes/data-schema-test.js +3 -5
  69. package/dist/esm/routes/data-schemas-list.js +3 -5
  70. package/dist/esm/routes/data-set.js +9 -5
  71. package/dist/esm/routes/data-transaction.js +28 -8
  72. package/dist/esm/routes/data-update.js +9 -4
  73. package/dist/esm/routes/meta-logs.js +36 -0
  74. package/dist/esm/routes/meta.js +3 -0
  75. package/dist/esm/routes/oauth2-signin.js +14 -10
  76. package/dist/esm/rules.js +5 -5
  77. package/dist/esm/server.js +6 -4
  78. package/dist/esm/settings/index.js +5 -6
  79. package/dist/esm/shared/rootpath.js +2 -0
  80. package/dist/esm/shared/signin.js +7 -3
  81. package/dist/esm/start.js +3 -0
  82. package/dist/esm/websocket/index.js +38 -23
  83. package/dist/esm/websocket/socket.io.js +9 -11
  84. package/dist/types/index.d.ts +2 -0
  85. package/dist/types/logger.d.ts +35 -0
  86. package/dist/types/middleware/admin-only.d.ts +19 -0
  87. package/dist/types/oauth-providers/dropbox.d.ts +3 -14
  88. package/dist/types/oauth-providers/facebook.d.ts +3 -7
  89. package/dist/types/oauth-providers/google.d.ts +3 -7
  90. package/dist/types/oauth-providers/index.d.ts +2 -10
  91. package/dist/types/oauth-providers/instagram.d.ts +3 -7
  92. package/dist/types/oauth-providers/oauth-provider.d.ts +25 -21
  93. package/dist/types/oauth-providers/spotify.d.ts +3 -7
  94. package/dist/types/routes/data-query.d.ts +1 -1
  95. package/dist/types/routes/meta-logs.d.ts +20 -0
  96. package/dist/types/rules.d.ts +4 -4
  97. package/dist/types/server.d.ts +9 -7
  98. package/dist/types/settings/email.d.ts +1 -1
  99. package/dist/types/settings/index.d.ts +5 -6
  100. package/dist/types/shared/clients.d.ts +3 -1
  101. package/dist/types/shared/env.d.ts +6 -4
  102. package/dist/types/shared/http.d.ts +2 -0
  103. package/dist/types/shared/signin.d.ts +1 -1
  104. package/dist/types/websocket/index.d.ts +4 -0
  105. package/dist/types/websocket/manager.d.ts +1 -1
  106. package/package.json +8 -8
  107. package/webmanager/acebase-client-browser.min.js +16 -0
  108. package/webmanager/index.html +2 -2
  109. package/webmanager/index.js +3 -6
  110. package/create-package-files +0 -12
  111. package/dist/cjs/auth.js.map +0 -1
  112. package/dist/cjs/cluster.js.map +0 -1
  113. package/dist/cjs/index.js.map +0 -1
  114. package/dist/cjs/middleware/404.js.map +0 -1
  115. package/dist/cjs/middleware/cache.js.map +0 -1
  116. package/dist/cjs/middleware/connection.js.map +0 -1
  117. package/dist/cjs/middleware/context.js.map +0 -1
  118. package/dist/cjs/middleware/cors.js.map +0 -1
  119. package/dist/cjs/middleware/swagger.js.map +0 -1
  120. package/dist/cjs/middleware/user.js.map +0 -1
  121. package/dist/cjs/oauth-providers/dropbox.js.map +0 -1
  122. package/dist/cjs/oauth-providers/facebook.js.map +0 -1
  123. package/dist/cjs/oauth-providers/google.js.map +0 -1
  124. package/dist/cjs/oauth-providers/index.js.map +0 -1
  125. package/dist/cjs/oauth-providers/instagram.js.map +0 -1
  126. package/dist/cjs/oauth-providers/oauth-provider.js.map +0 -1
  127. package/dist/cjs/oauth-providers/spotify.js.map +0 -1
  128. package/dist/cjs/routes/auth-change-password.js.map +0 -1
  129. package/dist/cjs/routes/auth-delete.js.map +0 -1
  130. package/dist/cjs/routes/auth-forgot-password.js.map +0 -1
  131. package/dist/cjs/routes/auth-reset-password.js.map +0 -1
  132. package/dist/cjs/routes/auth-signin.js.map +0 -1
  133. package/dist/cjs/routes/auth-signout.js.map +0 -1
  134. package/dist/cjs/routes/auth-signup.js.map +0 -1
  135. package/dist/cjs/routes/auth-state.js.map +0 -1
  136. package/dist/cjs/routes/auth-update.js.map +0 -1
  137. package/dist/cjs/routes/auth-verify-email.js.map +0 -1
  138. package/dist/cjs/routes/auth.js.map +0 -1
  139. package/dist/cjs/routes/data-exists.js.map +0 -1
  140. package/dist/cjs/routes/data-export.js.map +0 -1
  141. package/dist/cjs/routes/data-get.js.map +0 -1
  142. package/dist/cjs/routes/data-import.js.map +0 -1
  143. package/dist/cjs/routes/data-index-create.js.map +0 -1
  144. package/dist/cjs/routes/data-index-delete.js.map +0 -1
  145. package/dist/cjs/routes/data-index-list.js.map +0 -1
  146. package/dist/cjs/routes/data-query.js.map +0 -1
  147. package/dist/cjs/routes/data-reflect.js.map +0 -1
  148. package/dist/cjs/routes/data-schema-get.js.map +0 -1
  149. package/dist/cjs/routes/data-schema-set.js.map +0 -1
  150. package/dist/cjs/routes/data-schema-test.js.map +0 -1
  151. package/dist/cjs/routes/data-schemas-list.js.map +0 -1
  152. package/dist/cjs/routes/data-set.js.map +0 -1
  153. package/dist/cjs/routes/data-sync-changes.js.map +0 -1
  154. package/dist/cjs/routes/data-sync-mutations.js.map +0 -1
  155. package/dist/cjs/routes/data-transaction.js.map +0 -1
  156. package/dist/cjs/routes/data-update.js.map +0 -1
  157. package/dist/cjs/routes/data.js.map +0 -1
  158. package/dist/cjs/routes/docs.js.map +0 -1
  159. package/dist/cjs/routes/meta-info.js.map +0 -1
  160. package/dist/cjs/routes/meta-ping.js.map +0 -1
  161. package/dist/cjs/routes/meta-stats.js.map +0 -1
  162. package/dist/cjs/routes/meta.js.map +0 -1
  163. package/dist/cjs/routes/oauth2-init.js.map +0 -1
  164. package/dist/cjs/routes/oauth2-refresh.js.map +0 -1
  165. package/dist/cjs/routes/oauth2-signin.js.map +0 -1
  166. package/dist/cjs/routes/webmanager.js.map +0 -1
  167. package/dist/cjs/rules.js.map +0 -1
  168. package/dist/cjs/schema/user.js.map +0 -1
  169. package/dist/cjs/server.js.map +0 -1
  170. package/dist/cjs/settings/email.js.map +0 -1
  171. package/dist/cjs/settings/index.js.map +0 -1
  172. package/dist/cjs/shared/clients.js.map +0 -1
  173. package/dist/cjs/shared/email.js.map +0 -1
  174. package/dist/cjs/shared/env.js.map +0 -1
  175. package/dist/cjs/shared/error.js.map +0 -1
  176. package/dist/cjs/shared/http.js.map +0 -1
  177. package/dist/cjs/shared/password.js.map +0 -1
  178. package/dist/cjs/shared/rootpath.js.map +0 -1
  179. package/dist/cjs/shared/signin.js.map +0 -1
  180. package/dist/cjs/shared/simple-fetch.js.map +0 -1
  181. package/dist/cjs/shared/tokens.js.map +0 -1
  182. package/dist/cjs/shared/validate.js.map +0 -1
  183. package/dist/cjs/start.js.map +0 -1
  184. package/dist/cjs/test.js.map +0 -1
  185. package/dist/cjs/websocket/index.js.map +0 -1
  186. package/dist/cjs/websocket/manager.js.map +0 -1
  187. package/dist/cjs/websocket/socket.io.js.map +0 -1
  188. package/dist/esm/auth.js.map +0 -1
  189. package/dist/esm/cluster.js.map +0 -1
  190. package/dist/esm/index.js.map +0 -1
  191. package/dist/esm/middleware/404.js.map +0 -1
  192. package/dist/esm/middleware/cache.js.map +0 -1
  193. package/dist/esm/middleware/connection.js.map +0 -1
  194. package/dist/esm/middleware/context.js.map +0 -1
  195. package/dist/esm/middleware/cors.js.map +0 -1
  196. package/dist/esm/middleware/swagger.js.map +0 -1
  197. package/dist/esm/middleware/user.js.map +0 -1
  198. package/dist/esm/oauth-providers/dropbox.js.map +0 -1
  199. package/dist/esm/oauth-providers/facebook.js.map +0 -1
  200. package/dist/esm/oauth-providers/google.js.map +0 -1
  201. package/dist/esm/oauth-providers/index.js.map +0 -1
  202. package/dist/esm/oauth-providers/instagram.js.map +0 -1
  203. package/dist/esm/oauth-providers/oauth-provider.js.map +0 -1
  204. package/dist/esm/oauth-providers/spotify.js.map +0 -1
  205. package/dist/esm/routes/auth-change-password.js.map +0 -1
  206. package/dist/esm/routes/auth-delete.js.map +0 -1
  207. package/dist/esm/routes/auth-forgot-password.js.map +0 -1
  208. package/dist/esm/routes/auth-reset-password.js.map +0 -1
  209. package/dist/esm/routes/auth-signin.js.map +0 -1
  210. package/dist/esm/routes/auth-signout.js.map +0 -1
  211. package/dist/esm/routes/auth-signup.js.map +0 -1
  212. package/dist/esm/routes/auth-state.js.map +0 -1
  213. package/dist/esm/routes/auth-update.js.map +0 -1
  214. package/dist/esm/routes/auth-verify-email.js.map +0 -1
  215. package/dist/esm/routes/auth.js.map +0 -1
  216. package/dist/esm/routes/data-exists.js.map +0 -1
  217. package/dist/esm/routes/data-export.js.map +0 -1
  218. package/dist/esm/routes/data-get.js.map +0 -1
  219. package/dist/esm/routes/data-import.js.map +0 -1
  220. package/dist/esm/routes/data-index-create.js.map +0 -1
  221. package/dist/esm/routes/data-index-delete.js.map +0 -1
  222. package/dist/esm/routes/data-index-list.js.map +0 -1
  223. package/dist/esm/routes/data-query.js.map +0 -1
  224. package/dist/esm/routes/data-reflect.js.map +0 -1
  225. package/dist/esm/routes/data-schema-get.js.map +0 -1
  226. package/dist/esm/routes/data-schema-set.js.map +0 -1
  227. package/dist/esm/routes/data-schema-test.js.map +0 -1
  228. package/dist/esm/routes/data-schemas-list.js.map +0 -1
  229. package/dist/esm/routes/data-set.js.map +0 -1
  230. package/dist/esm/routes/data-sync-changes.js.map +0 -1
  231. package/dist/esm/routes/data-sync-mutations.js.map +0 -1
  232. package/dist/esm/routes/data-transaction.js.map +0 -1
  233. package/dist/esm/routes/data-update.js.map +0 -1
  234. package/dist/esm/routes/data.js.map +0 -1
  235. package/dist/esm/routes/docs.js.map +0 -1
  236. package/dist/esm/routes/meta-info.js.map +0 -1
  237. package/dist/esm/routes/meta-ping.js.map +0 -1
  238. package/dist/esm/routes/meta-stats.js.map +0 -1
  239. package/dist/esm/routes/meta.js.map +0 -1
  240. package/dist/esm/routes/oauth2-init.js.map +0 -1
  241. package/dist/esm/routes/oauth2-refresh.js.map +0 -1
  242. package/dist/esm/routes/oauth2-signin.js.map +0 -1
  243. package/dist/esm/routes/webmanager.js.map +0 -1
  244. package/dist/esm/rules.js.map +0 -1
  245. package/dist/esm/schema/user.js.map +0 -1
  246. package/dist/esm/server.js.map +0 -1
  247. package/dist/esm/settings/email.js.map +0 -1
  248. package/dist/esm/settings/index.js.map +0 -1
  249. package/dist/esm/shared/clients.js.map +0 -1
  250. package/dist/esm/shared/email.js.map +0 -1
  251. package/dist/esm/shared/env.js.map +0 -1
  252. package/dist/esm/shared/error.js.map +0 -1
  253. package/dist/esm/shared/http.js.map +0 -1
  254. package/dist/esm/shared/password.js.map +0 -1
  255. package/dist/esm/shared/rootpath.js.map +0 -1
  256. package/dist/esm/shared/signin.js.map +0 -1
  257. package/dist/esm/shared/simple-fetch.js.map +0 -1
  258. package/dist/esm/shared/tokens.js.map +0 -1
  259. package/dist/esm/shared/validate.js.map +0 -1
  260. package/dist/esm/start.js.map +0 -1
  261. package/dist/esm/test.js.map +0 -1
  262. package/dist/esm/websocket/index.js.map +0 -1
  263. package/dist/esm/websocket/manager.js.map +0 -1
  264. package/dist/esm/websocket/socket.io.js.map +0 -1
  265. package/src/auth.ts +0 -87
  266. package/src/cluster.ts +0 -62
  267. package/src/index.ts +0 -2
  268. package/src/middleware/404.ts +0 -13
  269. package/src/middleware/cache.ts +0 -15
  270. package/src/middleware/connection.ts +0 -48
  271. package/src/middleware/context.ts +0 -23
  272. package/src/middleware/cors.ts +0 -49
  273. package/src/middleware/swagger.ts +0 -19
  274. package/src/middleware/user.ts +0 -51
  275. package/src/oauth-providers/dropbox.ts +0 -143
  276. package/src/oauth-providers/facebook.ts +0 -102
  277. package/src/oauth-providers/google.ts +0 -146
  278. package/src/oauth-providers/index.ts +0 -20
  279. package/src/oauth-providers/instagram.ts +0 -97
  280. package/src/oauth-providers/oauth-provider.ts +0 -55
  281. package/src/oauth-providers/spotify.ts +0 -126
  282. package/src/routes/auth-change-password.ts +0 -89
  283. package/src/routes/auth-change-password.yaml +0 -74
  284. package/src/routes/auth-delete.ts +0 -47
  285. package/src/routes/auth-delete.yaml +0 -78
  286. package/src/routes/auth-forgot-password.ts +0 -73
  287. package/src/routes/auth-forgot-password.yaml +0 -50
  288. package/src/routes/auth-reset-password.ts +0 -93
  289. package/src/routes/auth-reset-password.yaml +0 -54
  290. package/src/routes/auth-signin.ts +0 -55
  291. package/src/routes/auth-signin.yaml +0 -130
  292. package/src/routes/auth-signout.ts +0 -61
  293. package/src/routes/auth-signout.yaml +0 -46
  294. package/src/routes/auth-signup.ts +0 -161
  295. package/src/routes/auth-signup.yaml +0 -136
  296. package/src/routes/auth-state.ts +0 -20
  297. package/src/routes/auth-state.yaml +0 -29
  298. package/src/routes/auth-update.ts +0 -147
  299. package/src/routes/auth-update.yaml +0 -152
  300. package/src/routes/auth-verify-email.ts +0 -67
  301. package/src/routes/auth-verify-email.yaml +0 -53
  302. package/src/routes/auth.ts +0 -67
  303. package/src/routes/data-exists.ts +0 -31
  304. package/src/routes/data-exists.yaml +0 -44
  305. package/src/routes/data-export.ts +0 -51
  306. package/src/routes/data-export.yaml +0 -64
  307. package/src/routes/data-get.ts +0 -68
  308. package/src/routes/data-get.yaml +0 -54
  309. package/src/routes/data-import.ts +0 -56
  310. package/src/routes/data-import.yaml +0 -75
  311. package/src/routes/data-index-create.ts +0 -85
  312. package/src/routes/data-index-create.yaml +0 -105
  313. package/src/routes/data-index-delete.ts +0 -39
  314. package/src/routes/data-index-delete.yaml +0 -51
  315. package/src/routes/data-index-list.ts +0 -42
  316. package/src/routes/data-index-list.yaml +0 -80
  317. package/src/routes/data-query.ts +0 -97
  318. package/src/routes/data-query.yaml +0 -166
  319. package/src/routes/data-reflect.ts +0 -94
  320. package/src/routes/data-reflect.yaml +0 -124
  321. package/src/routes/data-schema-get.ts +0 -38
  322. package/src/routes/data-schema-get.yaml +0 -53
  323. package/src/routes/data-schema-set.ts +0 -38
  324. package/src/routes/data-schema-set.yaml +0 -60
  325. package/src/routes/data-schema-test.ts +0 -53
  326. package/src/routes/data-schema-test.yaml +0 -66
  327. package/src/routes/data-schemas-list.ts +0 -33
  328. package/src/routes/data-schemas-list.yaml +0 -41
  329. package/src/routes/data-set.ts +0 -76
  330. package/src/routes/data-set.yaml +0 -71
  331. package/src/routes/data-sync-changes.ts +0 -78
  332. package/src/routes/data-sync-changes.yaml +0 -67
  333. package/src/routes/data-sync-mutations.ts +0 -78
  334. package/src/routes/data-sync-mutations.yaml +0 -67
  335. package/src/routes/data-transaction-finish.yaml +0 -76
  336. package/src/routes/data-transaction-start.yaml +0 -58
  337. package/src/routes/data-transaction.ts +0 -144
  338. package/src/routes/data-update.ts +0 -77
  339. package/src/routes/data-update.yaml +0 -71
  340. package/src/routes/data.ts +0 -79
  341. package/src/routes/docs.ts +0 -249
  342. package/src/routes/meta-info.ts +0 -80
  343. package/src/routes/meta-info.yaml +0 -41
  344. package/src/routes/meta-ping.ts +0 -15
  345. package/src/routes/meta-ping.yaml +0 -23
  346. package/src/routes/meta-stats.ts +0 -31
  347. package/src/routes/meta-stats.yaml +0 -41
  348. package/src/routes/meta.ts +0 -18
  349. package/src/routes/oauth2-init.ts +0 -44
  350. package/src/routes/oauth2-init.yaml +0 -63
  351. package/src/routes/oauth2-refresh.ts +0 -39
  352. package/src/routes/oauth2-refresh.yaml +0 -65
  353. package/src/routes/oauth2-signin.ts +0 -281
  354. package/src/routes/oauth2-signin.yaml +0 -66
  355. package/src/routes/webmanager.ts +0 -29
  356. package/src/rules.ts +0 -196
  357. package/src/schema/user.ts +0 -99
  358. package/src/server.ts +0 -416
  359. package/src/settings/email.ts +0 -18
  360. package/src/settings/index.ts +0 -240
  361. package/src/shared/clients.ts +0 -31
  362. package/src/shared/email.ts +0 -33
  363. package/src/shared/env.ts +0 -38
  364. package/src/shared/error.ts +0 -37
  365. package/src/shared/http.ts +0 -24
  366. package/src/shared/password.ts +0 -41
  367. package/src/shared/rootpath.ts +0 -15
  368. package/src/shared/signin.ts +0 -143
  369. package/src/shared/simple-fetch.ts +0 -65
  370. package/src/shared/tokens.ts +0 -77
  371. package/src/shared/validate.ts +0 -53
  372. package/src/start.ts +0 -45
  373. package/src/test.ts +0 -10
  374. package/src/websocket/index.ts +0 -320
  375. package/src/websocket/manager.ts +0 -46
  376. package/src/websocket/socket.io.ts +0 -91
  377. package/tsconfig-cjs.json +0 -10
  378. package/tsconfig.json +0 -21
@@ -7,6 +7,8 @@ const socketSignInFailed = `<html><script>window.close()</script><body>Failed to
7
7
  export const addRoute = (env) => {
8
8
  env.app.get(`/oauth2/${env.db.name}/signin`, async (req, res) => {
9
9
  // This is where the user is redirected to by the provider after signin or error
10
+ const LOG_ACTION = 'oauth2.signin';
11
+ const LOG_DETAILS = { ip: req.ip, provider: null };
10
12
  try {
11
13
  const state = parseSignedPublicToken(req.query.state, env.tokenSalt);
12
14
  if (req.query.error) {
@@ -23,6 +25,7 @@ export const addRoute = (env) => {
23
25
  // Got authorization code
24
26
  const authCode = req.query.code;
25
27
  const provider = env.authProviders[state.provider];
28
+ LOG_DETAILS.provider = state.provider;
26
29
  // Get access & refresh tokens
27
30
  const tokens = await provider.getAccessToken({ type: 'auth', auth_code: authCode, redirect_url: `${req.protocol}://${req.headers.host}/oauth2/${env.db.name}/signin` });
28
31
  let user_details;
@@ -42,12 +45,13 @@ export const addRoute = (env) => {
42
45
  if (contentType === 'image/png') { //state.provider === 'google' &&
43
46
  // Don't accept image/png, because it's probably a placeholder image. Google does this by creating a png with people's initials
44
47
  user_details.picture = [];
45
- return;
46
48
  }
47
- const image = await response.arrayBuffer();
48
- let buff = Buffer.from(image);
49
- best.url = `data:${contentType};base64,${buff.toString('base64')}`;
50
- user_details.picture = [best]; // Only keep the best one
49
+ else {
50
+ const image = await response.arrayBuffer();
51
+ let buff = Buffer.from(image);
52
+ best.url = `data:${contentType};base64,${buff.toString('base64')}`;
53
+ user_details.picture = [best]; // Only keep the best one
54
+ }
51
55
  }
52
56
  catch (err) {
53
57
  env.debug.warn(`Could not fetch profile picture from "${best.url}": `, err);
@@ -128,7 +132,7 @@ export const addRoute = (env) => {
128
132
  // Add provider details
129
133
  await env.authRef.child(uid).child('settings').update(getProviderSettings());
130
134
  // Log success
131
- env.logRef.push({ action: 'oauth2_signin', success: true, ip: req.ip, date: new Date(), uid });
135
+ env.log.event(LOG_ACTION, { ...LOG_DETAILS, uid });
132
136
  // Cache the user
133
137
  env.authCache.set(user.uid, user);
134
138
  // Request signin e-mail to be sent
@@ -148,13 +152,13 @@ export const addRoute = (env) => {
148
152
  provider: state.provider
149
153
  };
150
154
  env.config.email?.send(request).catch(err => {
151
- env.logRef.push({ action: 'oauth2_login_email', success: false, code: 'unexpected', ip: req.ip, date: new Date(), error: err.message, request });
155
+ env.log.error(LOG_ACTION + '.email', 'unexpected', { ...LOG_DETAILS, uid, request }, err);
152
156
  });
153
157
  }
154
158
  else if (snaps.length === 0) {
155
159
  // User does not exist, create
156
160
  if (!env.config.auth.allowUserSignup) {
157
- env.logRef.push({ action: 'oauth2_signup', success: false, code: 'user_signup_disabled', provider: state.provider, email: user_details.email, date: new Date() });
161
+ env.log.error(LOG_ACTION, 'user_signup_disabled', { ...LOG_DETAILS, email: user_details.email });
158
162
  res.statusCode = 403; // Forbidden
159
163
  return res.send({ code: 'admin_only', message: 'Only admin is allowed to create users' });
160
164
  }
@@ -181,7 +185,7 @@ export const addRoute = (env) => {
181
185
  const uid = userRef.key;
182
186
  user.uid = uid;
183
187
  // Log success
184
- env.logRef.push({ action: 'oauth2_signup', success: true, ip: req.ip, date: new Date(), uid });
188
+ env.log.event(LOG_ACTION, { ...LOG_DETAILS, uid });
185
189
  // Cache the user
186
190
  env.authCache.set(user.uid, user);
187
191
  // Request welcome e-mail to be sent
@@ -201,7 +205,7 @@ export const addRoute = (env) => {
201
205
  provider: state.provider
202
206
  };
203
207
  env.config.email?.send(request).catch(err => {
204
- env.logRef.push({ action: 'oauth2_signup_email', success: false, code: 'unexpected', ip: req.ip, date: new Date(), error: err.message, request });
208
+ env.log.error(LOG_ACTION + '.email', 'unexpected', { ...LOG_DETAILS, uid, request }, err);
205
209
  });
206
210
  }
207
211
  else {
package/dist/esm/rules.js CHANGED
@@ -61,11 +61,11 @@ export class PathBasedRules {
61
61
  rule.getText = () => {
62
62
  return text;
63
63
  };
64
- parent[key] = rule;
64
+ return parent[key] = rule;
65
65
  }
66
66
  else if (key === '.schema') {
67
67
  // Add schema
68
- env.db.schema.set(path, rule)
68
+ return env.db.schema.set(path, rule)
69
69
  .catch(err => {
70
70
  env.debug.error(`Error parsing ${path}/.schema: ${err.message}`);
71
71
  });
@@ -80,15 +80,15 @@ export class PathBasedRules {
80
80
  };
81
81
  processRules('', accessRules.rules, []);
82
82
  // Watch file for changes
83
- const wacthFileListener = () => {
83
+ const watchFileListener = () => {
84
84
  // Reload access rules
85
85
  const accessRules = readRules();
86
86
  processRules('', accessRules, []);
87
87
  this.accessRules = accessRules;
88
88
  };
89
- fs.watchFile(rulesFilePath, wacthFileListener);
89
+ fs.watchFile(rulesFilePath, watchFileListener);
90
90
  this.stop = () => {
91
- fs.unwatchFile(rulesFilePath, wacthFileListener);
91
+ fs.unwatchFile(rulesFilePath, watchFileListener);
92
92
  };
93
93
  process.on('SIGINT', this.stop);
94
94
  this.authEnabled = env.authEnabled;
@@ -17,6 +17,7 @@ import addWebManagerRoutes from './routes/webmanager.js';
17
17
  import addMetadataRoutes from './routes/meta.js';
18
18
  import addSwaggerMiddleware from './middleware/swagger.js';
19
19
  import addCacheMiddleware from './middleware/cache.js';
20
+ import { DatabaseLog } from './logger.js';
20
21
  // type PrivateLocalSettings = AceBaseLocalSettings & { storage: PrivateStorageSettings };
21
22
  export class AceBaseServerNotReadyError extends Error {
22
23
  constructor() { super('Server is not ready yet'); }
@@ -100,6 +101,7 @@ export class AceBaseServer extends SimpleEventEmitter {
100
101
  const securityRef = authDb ? authDb === db ? db.ref('__auth__/security') : authDb.ref('security') : null;
101
102
  const authRef = authDb ? authDb === db ? db.ref('__auth__/accounts') : authDb.ref('accounts') : null;
102
103
  const logRef = authDb ? authDb === db ? db.ref('__log__') : authDb.ref('log') : null;
104
+ const logger = new DatabaseLog(logRef);
103
105
  // Setup rules
104
106
  const rulesFilePath = `${this.config.path}/${this.db.name}.acebase/rules.json`;
105
107
  const rules = new PathBasedRules(rulesFilePath, config.auth.defaultAccessRule, { db, debug: this.debug, authEnabled: this.config.auth.enabled });
@@ -112,7 +114,7 @@ export class AceBaseServer extends SimpleEventEmitter {
112
114
  debug: this.debug,
113
115
  securityRef,
114
116
  authRef,
115
- logRef,
117
+ log: logger,
116
118
  tokenSalt: null,
117
119
  clients,
118
120
  authCache: null,
@@ -313,9 +315,9 @@ export class AceBaseServer extends SimpleEventEmitter {
313
315
  * .then(quote => {
314
316
  * console.log(`Got random quote: ${quote}`);
315
317
  * })
316
- * @param {'get'|'put'|'post'|'delete'} method
317
- * @param {string} ext_path
318
- * @param {(req: Express.Request, res: Express.Response)} handler
318
+ * @param method http method to bind to
319
+ * @param ext_path path to bind to (appended to /ext/)
320
+ * @param handler your Express request handler callback
319
321
  */
320
322
  extend(method, ext_path, handler) {
321
323
  throw new AceBaseServerNotReadyError();
@@ -16,12 +16,11 @@ export class AceBaseServerHttpsConfig {
16
16
  }
17
17
  }
18
18
  }
19
- export var AUTH_ACCESS_DEFAULT;
20
- (function (AUTH_ACCESS_DEFAULT) {
21
- AUTH_ACCESS_DEFAULT["DENY_ALL"] = "deny";
22
- AUTH_ACCESS_DEFAULT["ALLOW_ALL"] = "allow";
23
- AUTH_ACCESS_DEFAULT["ALLOW_AUTHENTICATED"] = "auth";
24
- })(AUTH_ACCESS_DEFAULT || (AUTH_ACCESS_DEFAULT = {}));
19
+ export const AUTH_ACCESS_DEFAULT = {
20
+ DENY_ALL: 'deny',
21
+ ALLOW_ALL: 'allow',
22
+ ALLOW_AUTHENTICATED: 'auth'
23
+ };
25
24
  export class AceBaseServerAuthenticationSettings {
26
25
  constructor(settings) {
27
26
  /**
@@ -7,6 +7,8 @@ if (process.platform === 'win32' && currentDir.startsWith('/')) {
7
7
  // tsc-esm-fix does not handle win32 file urls correctly, the drive letter in import.meta.url is prefixed with a slash: file:///C:/dir/file.js
8
8
  currentDir = currentDir.slice(1);
9
9
  }
10
+ // tsc-esm-fix also does not use decodeURI to remove encoded characters (such as %20 for spaces)
11
+ currentDir = decodeURI(currentDir);
10
12
  export const packageRootPath = resolve(currentDir, '../../..');
11
13
  export default packageRootPath;
12
14
  //# sourceMappingURL=rootpath.js.map
@@ -17,6 +17,8 @@ export class SignInError extends Error {
17
17
  * @returns
18
18
  */
19
19
  export const signIn = async (credentials, env, req) => {
20
+ const LOG_ACTION = 'auth.signin';
21
+ const LOG_DETAILS = { ip: req.ip, method: credentials.method };
20
22
  try {
21
23
  const query = env.authRef.query();
22
24
  let tokenDetails;
@@ -34,7 +36,7 @@ export const signIn = async (credentials, env, req) => {
34
36
  }
35
37
  break;
36
38
  }
37
- case 'private_token': {
39
+ case 'internal': {
38
40
  // Method used internally: uses the access token extracted from a public access token (see tokenDetails.access_token in above 'token' case)
39
41
  if (typeof credentials.access_token !== 'string') {
40
42
  throw new SignInError('invalid_details', 'sign in request has invalid arguments');
@@ -109,7 +111,9 @@ export const signIn = async (credentials, env, req) => {
109
111
  // Update db
110
112
  await snap.ref.update(updates);
111
113
  // Log history item
112
- env.logRef.push({ action: `signin`, type: credentials.method, [credentials.method]: credentials[credentials.method], ip: req.ip, date: new Date(), success: true });
114
+ if (credentials.method !== 'internal') {
115
+ env.log.event(LOG_ACTION, LOG_DETAILS);
116
+ }
113
117
  // Add to cache
114
118
  env.authCache.set(user.uid, user);
115
119
  // Bind user to current request
@@ -118,7 +122,7 @@ export const signIn = async (credentials, env, req) => {
118
122
  }
119
123
  catch (err) {
120
124
  // Log error
121
- env.logRef.push({ action: 'signin', type: credentials.method, [credentials.method]: credentials[credentials.method], success: false, code: err.code || 'unexpected', message: err.code ? null : err.message, ip: req.ip, date: new Date(), ...err.details });
125
+ env.log.error(LOG_ACTION, err.code ?? 'unexpected', LOG_DETAILS, typeof err.code === 'undefined' ? err : null);
122
126
  throw err;
123
127
  }
124
128
  };
package/dist/esm/start.js CHANGED
@@ -40,6 +40,9 @@ if (+getVariable('TXLOG', 0) === 1) {
40
40
  maxAge: +getVariable('TXDAYS', 30)
41
41
  };
42
42
  }
43
+ if (+getVariable('AUTH', 1) === 0) {
44
+ options.authentication = { enabled: false };
45
+ }
43
46
  const server = new AceBaseServer(dbname, options);
44
47
  server.once("ready", () => {
45
48
  server.debug.log(`AceBase server running`);
@@ -2,6 +2,12 @@ import { ColorStyle, Transport } from "acebase-core";
2
2
  import { ConnectedClient } from "../shared/clients.js";
3
3
  import { decodePublicAccessToken } from "../shared/tokens.js";
4
4
  import { createServer } from "./socket.io.js";
5
+ export class SocketRequestError extends Error {
6
+ constructor(code, message) {
7
+ super(message);
8
+ this.code = code;
9
+ }
10
+ }
5
11
  export const addWebsocketServer = (env) => {
6
12
  // TODO: Allow using uWebSockets.js server instead of Socket.IO
7
13
  const serverManager = createServer(env);
@@ -94,7 +100,7 @@ export const addWebsocketServer = (env) => {
94
100
  serverManager.send(event.socket, 'oauth2-signin', { error: err.message });
95
101
  }
96
102
  });
97
- const acknowlegdeRequest = (socket, requestId) => {
103
+ const acknowledgeRequest = (socket, requestId) => {
98
104
  // Send acknowledgement
99
105
  serverManager.send(socket, 'result', {
100
106
  success: true,
@@ -119,12 +125,12 @@ export const addWebsocketServer = (env) => {
119
125
  const subscriptionPath = event.data.path;
120
126
  const isSubscribed = () => subscriptionPath in client.subscriptions && client.subscriptions[subscriptionPath].some(s => s.event === event.data.event);
121
127
  if (isSubscribed()) {
122
- return acknowlegdeRequest(event.socket, event.data.req_id);
128
+ return acknowledgeRequest(event.socket, event.data.req_id);
123
129
  }
124
130
  // Get client
125
131
  // const client = clients.get(socket.id);
126
132
  if (!env.rules.userHasAccess(client.user, subscriptionPath, false)) {
127
- env.logRef.push({ action: 'subscribe', success: false, code: 'access_denied', uid: client.user ? client.user.uid : '-', path: subscriptionPath });
133
+ env.log.error('event.subscribe', 'access_denied', { uid: client.user?.uid ?? 'anonymous', path: subscriptionPath });
128
134
  return failRequest(event.socket, event.data.req_id, 'access_denied');
129
135
  }
130
136
  const callback = (err, path, currentValue, previousValue, context) => {
@@ -165,7 +171,7 @@ export const addWebsocketServer = (env) => {
165
171
  let subscr = { path: subscriptionPath, event: event.data.event, callback };
166
172
  pathSubs.push(subscr);
167
173
  env.db.api.subscribe(subscriptionPath, event.data.event, callback);
168
- acknowlegdeRequest(event.socket, event.data.req_id);
174
+ acknowledgeRequest(event.socket, event.data.req_id);
169
175
  });
170
176
  serverManager.on('unsubscribe', event => {
171
177
  // Client unsubscribes from events on a node
@@ -178,7 +184,7 @@ export const addWebsocketServer = (env) => {
178
184
  let pathSubs = client.subscriptions[event.data.path];
179
185
  if (!pathSubs) {
180
186
  // We have no knowledge of any active subscriptions on this path
181
- return acknowlegdeRequest(event.socket, event.data.req_id);
187
+ return acknowledgeRequest(event.socket, event.data.req_id);
182
188
  }
183
189
  let remove = pathSubs;
184
190
  if (event.data.event) {
@@ -195,7 +201,7 @@ export const addWebsocketServer = (env) => {
195
201
  // No subscriptions left on this path, remove the path entry
196
202
  delete client.subscriptions[event.data.path];
197
203
  }
198
- return acknowlegdeRequest(event.socket, event.data.req_id);
204
+ return acknowledgeRequest(event.socket, event.data.req_id);
199
205
  });
200
206
  serverManager.on('query-unsubscribe', event => {
201
207
  // Client unsubscribing from realtime query events
@@ -206,15 +212,17 @@ export const addWebsocketServer = (env) => {
206
212
  env.debug.verbose(`Client ${event.socket_id} is unsubscribing from realtime query "${event.data.query_id}"`);
207
213
  // const client = clients.get(socket.id);
208
214
  delete client.realtimeQueries[event.data.query_id];
209
- acknowlegdeRequest(event.socket, event.data.req_id);
215
+ acknowledgeRequest(event.socket, event.data.req_id);
210
216
  });
211
217
  const TRANSACTION_TIMEOUT_MS = 10000; // 10s to finish a started transaction
212
218
  serverManager.on('transaction-start', event => {
213
219
  // Start transaction
214
220
  const client = getClientBySocketId(event.socket_id, 'transaction-start');
215
- if (!client) {
221
+ if (!client || !event.data) {
216
222
  return;
217
223
  }
224
+ const LOG_ACTION = 'socket.transaction.start';
225
+ const LOG_DETAILS = { ip: event.socket.conn.remoteAddress, uid: client.user?.uid ?? null, path: event.data.path };
218
226
  env.debug.verbose(`Client ${event.socket_id} is sending transaction start request on path "${event.data.path}"`);
219
227
  const data = event.data;
220
228
  const tx = {
@@ -226,11 +234,14 @@ export const addWebsocketServer = (env) => {
226
234
  timeout: setTimeout(() => {
227
235
  delete client.transactions[tx.id];
228
236
  tx.finish(); // Finish without value cancels the transaction
237
+ env.log.error(LOG_ACTION, 'timeout', LOG_DETAILS);
229
238
  serverManager.send(event.socket, 'tx_error', { id: tx.id, reason: 'timeout' });
230
239
  }, TRANSACTION_TIMEOUT_MS)
231
240
  };
232
- if (!env.rules.userHasAccess(client.user, data.path, true)) {
241
+ const access = env.rules.userHasAccess(client.user, data.path, true);
242
+ if (!access.allow) {
233
243
  // throw new AccessDeniedError(`access_denied`);
244
+ env.log.error(LOG_ACTION, 'unauthorized', { ...LOG_DETAILS, rule_code: access.code, rule_path: access.rulePath ?? null }, access.details);
234
245
  return serverManager.send(event.socket, 'tx_error', { id: tx.id, reason: 'access_denied' });
235
246
  }
236
247
  // Bind to client
@@ -254,32 +265,36 @@ export const addWebsocketServer = (env) => {
254
265
  serverManager.on('transaction-finish', async (event) => {
255
266
  // Finish transaction
256
267
  const client = getClientBySocketId(event.socket_id, 'transaction-finish');
257
- if (!client) {
268
+ if (!client || !event.data) {
258
269
  return;
259
270
  }
271
+ const LOG_ACTION = 'socket.transaction.finish';
272
+ const LOG_DETAILS = { ip: event.socket.conn.remoteAddress, uid: client.user?.uid ?? null, path: event.data.path };
260
273
  const data = event.data;
261
274
  const tx = client.transactions[data.id];
262
275
  try {
263
276
  if (!tx || data.path !== tx.path) {
264
- throw new Error('transaction_not_found');
277
+ env.log.error(LOG_ACTION, tx ? 'wrong_path' : 'not_found', { ...LOG_DETAILS, id: data.id, tx_path: tx?.path ?? null });
278
+ throw new SocketRequestError('transaction_not_found', 'Transaction not found');
265
279
  }
266
280
  clearTimeout(tx.timeout);
267
281
  delete client.transactions[data.id];
268
- if (!env.rules.userHasAccess(client.user, data.path, true)) {
269
- throw new Error('access_denied');
270
- }
271
- const newValue = Transport.deserialize(data.value);
272
- try {
273
- await tx.finish(newValue);
274
- env.debug.verbose(`Transaction ${tx.id} finished`);
275
- serverManager.send(event.socket, 'tx_completed', { id: tx.id });
276
- }
277
- catch (err) {
278
- serverManager.send(event.socket, 'tx_error', { id: tx.id, reason: err.message });
282
+ const access = env.rules.userHasAccess(client.user, data.path, true);
283
+ if (!access.allow) {
284
+ env.log.error(LOG_ACTION, 'unauthorized', { ...LOG_DETAILS, rule_code: access.code, rule_path: access.rulePath ?? null }, access.details);
285
+ throw new SocketRequestError('access_denied', 'Access denied');
279
286
  }
287
+ const newValue = 'val' in data.value ? Transport.deserialize(data.value) : undefined;
288
+ const { cursor } = await tx.finish(newValue);
289
+ env.debug.verbose(`Transaction ${tx.id} finished`);
290
+ serverManager.send(event.socket, 'tx_completed', { id: tx.id, context: { cursor } });
280
291
  }
281
292
  catch (err) {
282
- serverManager.send(event.socket, 'tx_error', { id: tx.id, reason: err.message, data });
293
+ if (!(err instanceof SocketRequestError)) {
294
+ // Other errors have been logged already
295
+ env.log.error(LOG_ACTION, 'unexpected', LOG_DETAILS, err);
296
+ }
297
+ serverManager.send(event.socket, 'tx_error', { id: tx.id, reason: err.code ?? err.message, data });
283
298
  tx.finish(); // Finish with undefined, canceling the transaction
284
299
  }
285
300
  });
@@ -1,7 +1,9 @@
1
- import * as socketIO from 'socket.io';
2
- const createSocketIOServer = socketIO.default ?? socketIO; // ESM and CJS compatible approach
1
+ import { Server as SocketIOServer } from 'socket.io';
2
+ const createSocketIOServer = (httpServer, options) => {
3
+ return new SocketIOServer(httpServer, options);
4
+ };
3
5
  import { WebSocketManager } from './manager.js';
4
- import { getCorsHeaders } from '../middleware/cors.js';
6
+ import { getCorsOptions } from '../middleware/cors.js';
5
7
  export class SocketIOManager extends WebSocketManager {
6
8
  constructor() {
7
9
  super('Socket.IO');
@@ -31,14 +33,10 @@ export const createServer = (env) => {
31
33
  pingInterval: 5000,
32
34
  pingTimeout: 5000,
33
35
  maxHttpBufferSize: maxPayloadBytes,
34
- // socket.io 2.x:
35
- handlePreflightRequest: (req, res) => {
36
- const headers = getCorsHeaders(env.config.allowOrigin, req.headers.origin);
37
- res.writeHead(200, headers);
38
- res.end();
39
- }
36
+ // Allow socket.io 2.x clients (using engine.io 3.x):
37
+ allowEIO3: true,
40
38
  // socket.io 3+ uses cors package:
41
- // cors: getCorsOptions(env.config.allowOrigin)
39
+ cors: getCorsOptions(env.config.allowOrigin)
42
40
  });
43
41
  // Setup event emitter for communication with consuming server
44
42
  const manager = new SocketIOManager();
@@ -47,7 +45,7 @@ export const createServer = (env) => {
47
45
  // Notify manager of new connection
48
46
  manager.emit('connect', { socket, socket_id: socket.id });
49
47
  // Pass any events to manager
50
- socket.on('disconnect', data => manager.emit('disconnect', { socket, socket_id: socket.id, data }));
48
+ socket.on('disconnect', reason => manager.emit('disconnect', { socket, socket_id: socket.id, data: reason }));
51
49
  socket.on('reconnect', data => manager.emit('connect', { socket, socket_id: socket.id, data }));
52
50
  socket.on('signin', accessToken => manager.emit('signin', { socket, socket_id: socket.id, data: { accessToken } }));
53
51
  socket.on('signout', data => manager.emit('signout', { socket, socket_id: socket.id, data }));
@@ -1,2 +1,4 @@
1
1
  export { AceBaseServer } from './server';
2
2
  export { AceBaseServerSettings, AceBaseServerHttpsSettings, AceBaseServerTransactionSettings, AceBaseServerAuthenticationSettings } from './settings';
3
+ export * from './shared/email';
4
+ export * from './oauth-providers';
@@ -0,0 +1,35 @@
1
+ import { DataReference } from "acebase-core";
2
+ export declare class DatabaseLog {
3
+ private logRef;
4
+ constructor(logRef: DataReference);
5
+ /**
6
+ * Logs an action initiated by a client/user with a positive or negative outcome. Used by `success` and `failure`
7
+ * @param action action identifier
8
+ * @param success whether the action was successful
9
+ * @param details any additional details to be logged
10
+ */
11
+ event(action: string, details: any): Promise<void>;
12
+ /**
13
+ * Logs a system warning
14
+ * @param action action identifier
15
+ * @param code warning code
16
+ * @param details any additional details to be logged
17
+ */
18
+ warning(action: string, code: string, details: any): Promise<void>;
19
+ /**
20
+ * Logs a system or client/user error
21
+ * @param action action identifier
22
+ * @param code error code
23
+ * @param details any additional details to be logged
24
+ */
25
+ error(action: string, code: string, details: any, unexpectedError?: any): Promise<void>;
26
+ /**
27
+ * Query the logs
28
+ * @returns
29
+ */
30
+ query(): import("acebase-core").DataReferenceQuery;
31
+ /**
32
+ * Reference to the logs database collection
33
+ */
34
+ get ref(): DataReference;
35
+ }
@@ -0,0 +1,19 @@
1
+ import { NextFunction } from "express";
2
+ import { RouteInitEnvironment, RouteRequest } from "../shared/env";
3
+ import type { Response } from "../shared/http";
4
+ /**
5
+ * Middleware function that checks if the current user is `admin`. An 403 Forbidden error will be sent in the response if
6
+ * authentication is enabled on the server and the user is not signed in as admin.
7
+ *
8
+ * Can be applied to any route by adding it in the router chain.
9
+ * @example
10
+ * app.get('/endpoint', adminOnly(env), (req, res) => {
11
+ * // If we get here we are either an admin,
12
+ * // or the server doesn't have authentication enabled.
13
+ * })
14
+ * @param env Middle
15
+ * @param errorMessage
16
+ * @returns
17
+ */
18
+ export declare const adminOnly: (env: RouteInitEnvironment, errorMessage?: string) => (req: RouteRequest, res: Response, next: NextFunction) => void;
19
+ export default adminOnly;
@@ -1,4 +1,4 @@
1
- import { IOAuth2Provider, IOAuth2ProviderSettings, IOAuth2AuthCodeParams, IOAuth2RefreshTokenParams } from "./oauth-provider";
1
+ import { IOAuth2ProviderSettings, IOAuth2AuthCodeParams, IOAuth2RefreshTokenParams, OAuth2Provider, OAuth2ProviderInitInfo } from "./oauth-provider";
2
2
  /**
3
3
  * Details of your app to access the Dropbox API
4
4
  */
@@ -16,8 +16,7 @@ interface IDropboxAuthToken {
16
16
  account_id: string;
17
17
  uid: string;
18
18
  }
19
- export declare class DropboxAuthProvider implements IOAuth2Provider {
20
- private settings;
19
+ export declare class DropboxAuthProvider extends OAuth2Provider {
21
20
  constructor(settings: IDropboxAuthSettings);
22
21
  /**
23
22
  * Starts auth flow by getting the url the user should be redirected to
@@ -30,17 +29,7 @@ export declare class DropboxAuthProvider implements IOAuth2Provider {
30
29
  * @param info.options.locale If the locale specified is a supported language, Dropbox will direct users to a translated version of the authorization website. Locale tags should be IETF language tags.
31
30
  * @param info.options.force_reauthentication When true (default is false) users will be signed out if they are currently signed in. This will make sure the user is brought to a page where they can create a new account or sign in to another account. This should only be used when there is a definite reason to believe that the user needs to sign in to a new or different account.
32
31
  */
33
- init(info: {
34
- redirect_url: string;
35
- state?: string;
36
- options?: {
37
- locale?: string;
38
- require_role?: string;
39
- disable_signup?: boolean;
40
- force_reapprove?: boolean;
41
- force_reauthentication?: boolean;
42
- };
43
- }): Promise<string>;
32
+ init(info: OAuth2ProviderInitInfo): Promise<string>;
44
33
  getAccessToken(params: IOAuth2AuthCodeParams | IOAuth2RefreshTokenParams): Promise<IDropboxAuthToken>;
45
34
  getUserInfo(access_token: string): Promise<{
46
35
  id: string;
@@ -1,4 +1,4 @@
1
- import { IOAuth2Provider, IOAuth2ProviderSettings, IOAuth2AuthCodeParams, IOAuth2RefreshTokenParams } from "./oauth-provider";
1
+ import { IOAuth2ProviderSettings, IOAuth2AuthCodeParams, IOAuth2RefreshTokenParams, OAuth2Provider, OAuth2ProviderInitInfo } from "./oauth-provider";
2
2
  /**
3
3
  * Details of your app to access the Facebook Graph API
4
4
  */
@@ -14,18 +14,14 @@ interface IFacebookAuthToken {
14
14
  scope: string;
15
15
  token_type: string;
16
16
  }
17
- export declare class FacebookAuthProvider implements IOAuth2Provider {
18
- private settings;
17
+ export declare class FacebookAuthProvider extends OAuth2Provider {
19
18
  constructor(settings: IFacebookAuthSettings);
20
19
  /**
21
20
  * Starts auth flow by getting the url the user should be redirected to
22
21
  * @param info.redirectUrl Url spotify will redirect to after authorizing, should be the url
23
22
  * @param info.state Optional state that will be passed to redirectUri by spotify
24
23
  */
25
- init(info: {
26
- redirect_url: string;
27
- state?: string;
28
- }): Promise<string>;
24
+ init(info: OAuth2ProviderInitInfo): Promise<string>;
29
25
  getAccessToken(params: IOAuth2AuthCodeParams | IOAuth2RefreshTokenParams): Promise<IFacebookAuthToken>;
30
26
  getUserInfo(access_token: string): Promise<{
31
27
  id: string;
@@ -1,4 +1,4 @@
1
- import { IOAuth2Provider, IOAuth2ProviderSettings, IOpenIDToken, IOpenIDConfiguration, IOAuth2AuthCodeParams, IOAuth2RefreshTokenParams } from "./oauth-provider";
1
+ import { IOAuth2ProviderSettings, IOpenIDToken, IOpenIDConfiguration, IOAuth2AuthCodeParams, IOAuth2RefreshTokenParams, OAuth2ProviderInitInfo, OAuth2Provider } from "./oauth-provider";
2
2
  /**
3
3
  * Details of your app to access the Google API. See https://developers.google.com/identity/protocols/oauth2/scopes
4
4
  */
@@ -15,8 +15,7 @@ interface IGoogleAuthToken {
15
15
  scope: string;
16
16
  token_type: string;
17
17
  }
18
- export declare class GoogleAuthProvider implements IOAuth2Provider {
19
- private settings;
18
+ export declare class GoogleAuthProvider extends OAuth2Provider {
20
19
  _config: IOpenIDConfiguration;
21
20
  constructor(settings: IGoogleAuthSettings);
22
21
  getOpenIDConfig(): Promise<IOpenIDConfiguration>;
@@ -25,10 +24,7 @@ export declare class GoogleAuthProvider implements IOAuth2Provider {
25
24
  * @param info.redirectUrl Url spotify will redirect to after authorizing, should be the url
26
25
  * @param info.state Optional state that will be passed to redirectUri by spotify
27
26
  */
28
- init(info: {
29
- redirect_url: string;
30
- state?: string;
31
- }): Promise<string>;
27
+ init(info: OAuth2ProviderInitInfo): Promise<string>;
32
28
  getAccessToken(params: IOAuth2AuthCodeParams | IOAuth2RefreshTokenParams): Promise<IGoogleAuthToken>;
33
29
  revokeAccess(access_token: string): Promise<void>;
34
30
  getUserInfo(access_token: string): Promise<{
@@ -1,18 +1,10 @@
1
- import { DropboxAuthProvider } from './dropbox';
2
- import { FacebookAuthProvider } from './facebook';
3
- import { GoogleAuthProvider } from './google';
4
- import { InstagramAuthProvider } from './instagram';
5
- import { SpotifyAuthProvider } from './spotify';
1
+ import { OAuth2Provider } from './oauth-provider';
6
2
  export { DropboxAuthProvider, IDropboxAuthSettings } from './dropbox';
7
3
  export { FacebookAuthProvider, IFacebookAuthSettings } from './facebook';
8
4
  export { GoogleAuthProvider, IGoogleAuthSettings } from './google';
9
5
  export { InstagramAuthProvider, IInstagramAuthSettings } from './instagram';
10
6
  export { SpotifyAuthProvider, ISpotifyAuthSettings } from './spotify';
11
7
  declare const oAuth2Providers: {
12
- dropbox: typeof DropboxAuthProvider;
13
- facebook: typeof FacebookAuthProvider;
14
- google: typeof GoogleAuthProvider;
15
- instagram: typeof InstagramAuthProvider;
16
- spotify: typeof SpotifyAuthProvider;
8
+ [key: string]: typeof OAuth2Provider;
17
9
  };
18
10
  export default oAuth2Providers;
@@ -1,4 +1,4 @@
1
- import { IOAuth2Provider, IOAuth2ProviderSettings, IOAuth2AuthCodeParams } from "./oauth-provider";
1
+ import { IOAuth2ProviderSettings, IOAuth2AuthCodeParams, OAuth2Provider, OAuth2ProviderInitInfo } from "./oauth-provider";
2
2
  /**
3
3
  * Details of your app to access the Legacy Instagram API.
4
4
  */
@@ -24,18 +24,14 @@ interface IInstagramUser {
24
24
  followed_by: number;
25
25
  };
26
26
  }
27
- export declare class InstagramAuthProvider implements IOAuth2Provider {
28
- private settings;
27
+ export declare class InstagramAuthProvider extends OAuth2Provider {
29
28
  constructor(settings: IInstagramAuthSettings);
30
29
  /**
31
30
  * Starts auth flow by getting the url the user should be redirected to
32
31
  * @param info.redirectUrl Url spotify will redirect to after authorizing, should be the url
33
32
  * @param info.state Optional state that will be passed to redirectUri by spotify
34
33
  */
35
- init(info: {
36
- redirect_url: string;
37
- state?: string;
38
- }): Promise<string>;
34
+ init(info: OAuth2ProviderInitInfo): Promise<string>;
39
35
  _userInfo: IInstagramUser;
40
36
  getAccessToken(params: IOAuth2AuthCodeParams): Promise<IInstagramAuthToken>;
41
37
  getUserInfo(access_token: string): Promise<{