acebase-server 1.8.0 → 1.10.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 (509) hide show
  1. package/.vscode/launch.json +24 -0
  2. package/create-package-files +12 -0
  3. package/dist/cjs/auth.js +89 -0
  4. package/dist/cjs/auth.js.map +1 -0
  5. package/dist/cjs/cluster.js +57 -0
  6. package/dist/cjs/cluster.js.map +1 -0
  7. package/dist/cjs/index.js +9 -0
  8. package/dist/cjs/index.js.map +1 -0
  9. package/dist/cjs/middleware/404.js +15 -0
  10. package/dist/cjs/middleware/404.js.map +1 -0
  11. package/dist/cjs/middleware/cache.js +15 -0
  12. package/dist/cjs/middleware/cache.js.map +1 -0
  13. package/dist/cjs/middleware/connection.js +50 -0
  14. package/dist/cjs/middleware/connection.js.map +1 -0
  15. package/dist/cjs/middleware/context.js +21 -0
  16. package/dist/cjs/middleware/context.js.map +1 -0
  17. package/dist/cjs/middleware/cors.js +51 -0
  18. package/dist/cjs/middleware/cors.js.map +1 -0
  19. package/dist/cjs/middleware/swagger.js +18 -0
  20. package/dist/cjs/middleware/swagger.js.map +1 -0
  21. package/dist/cjs/middleware/user.js +58 -0
  22. package/dist/cjs/middleware/user.js.map +1 -0
  23. package/dist/cjs/oauth-providers/dropbox.js +109 -0
  24. package/dist/cjs/oauth-providers/dropbox.js.map +1 -0
  25. package/dist/cjs/oauth-providers/facebook.js +85 -0
  26. package/dist/cjs/oauth-providers/facebook.js.map +1 -0
  27. package/dist/cjs/oauth-providers/google.js +125 -0
  28. package/dist/cjs/oauth-providers/google.js.map +1 -0
  29. package/dist/cjs/oauth-providers/index.js +27 -0
  30. package/dist/cjs/oauth-providers/index.js.map +1 -0
  31. package/dist/cjs/oauth-providers/instagram.js +80 -0
  32. package/dist/cjs/oauth-providers/instagram.js.map +1 -0
  33. package/dist/cjs/oauth-providers/oauth-provider.js +3 -0
  34. package/dist/cjs/oauth-providers/oauth-provider.js.map +1 -0
  35. package/dist/cjs/oauth-providers/spotify.js +113 -0
  36. package/dist/cjs/oauth-providers/spotify.js.map +1 -0
  37. package/dist/cjs/package.json +3 -0
  38. package/dist/cjs/routes/auth-change-password.js +85 -0
  39. package/dist/cjs/routes/auth-change-password.js.map +1 -0
  40. package/dist/cjs/routes/auth-delete.js +51 -0
  41. package/dist/cjs/routes/auth-delete.js.map +1 -0
  42. package/dist/cjs/routes/auth-forgot-password.js +75 -0
  43. package/dist/cjs/routes/auth-forgot-password.js.map +1 -0
  44. package/dist/cjs/routes/auth-reset-password.js +94 -0
  45. package/dist/cjs/routes/auth-reset-password.js.map +1 -0
  46. package/dist/cjs/routes/auth-signin.js +47 -0
  47. package/dist/cjs/routes/auth-signin.js.map +1 -0
  48. package/dist/cjs/routes/auth-signout.js +60 -0
  49. package/dist/cjs/routes/auth-signout.js.map +1 -0
  50. package/dist/cjs/routes/auth-signup.js +141 -0
  51. package/dist/cjs/routes/auth-signup.js.map +1 -0
  52. package/dist/cjs/routes/auth-state.js +26 -0
  53. package/dist/cjs/routes/auth-state.js.map +1 -0
  54. package/dist/cjs/routes/auth-update.js +129 -0
  55. package/dist/cjs/routes/auth-update.js.map +1 -0
  56. package/dist/cjs/routes/auth-verify-email.js +67 -0
  57. package/dist/cjs/routes/auth-verify-email.js.map +1 -0
  58. package/dist/cjs/routes/auth.js +55 -0
  59. package/dist/cjs/routes/auth.js.map +1 -0
  60. package/dist/cjs/routes/data-exists.js +34 -0
  61. package/dist/cjs/routes/data-exists.js.map +1 -0
  62. package/dist/cjs/routes/data-export.js +49 -0
  63. package/dist/cjs/routes/data-export.js.map +1 -0
  64. package/dist/cjs/routes/data-get.js +67 -0
  65. package/dist/cjs/routes/data-get.js.map +1 -0
  66. package/dist/cjs/routes/data-import.js +55 -0
  67. package/dist/cjs/routes/data-import.js.map +1 -0
  68. package/dist/cjs/routes/data-index-create.js +45 -0
  69. package/dist/cjs/routes/data-index-create.js.map +1 -0
  70. package/dist/cjs/routes/data-index-delete.js +36 -0
  71. package/dist/cjs/routes/data-index-delete.js.map +1 -0
  72. package/dist/cjs/routes/data-index-list.js +35 -0
  73. package/dist/cjs/routes/data-index-list.js.map +1 -0
  74. package/dist/cjs/routes/data-query.js +71 -0
  75. package/dist/cjs/routes/data-query.js.map +1 -0
  76. package/dist/cjs/routes/data-reflect.js +89 -0
  77. package/dist/cjs/routes/data-reflect.js.map +1 -0
  78. package/dist/cjs/routes/data-schema-get.js +39 -0
  79. package/dist/cjs/routes/data-schema-get.js.map +1 -0
  80. package/dist/cjs/routes/data-schema-set.js +33 -0
  81. package/dist/cjs/routes/data-schema-set.js.map +1 -0
  82. package/dist/cjs/routes/data-schema-test.js +46 -0
  83. package/dist/cjs/routes/data-schema-test.js.map +1 -0
  84. package/dist/cjs/routes/data-schemas-list.js +35 -0
  85. package/dist/cjs/routes/data-schemas-list.js.map +1 -0
  86. package/dist/cjs/routes/data-set.js +72 -0
  87. package/dist/cjs/routes/data-set.js.map +1 -0
  88. package/dist/cjs/routes/data-sync-changes.js +68 -0
  89. package/dist/cjs/routes/data-sync-changes.js.map +1 -0
  90. package/dist/cjs/routes/data-sync-mutations.js +68 -0
  91. package/dist/cjs/routes/data-sync-mutations.js.map +1 -0
  92. package/dist/cjs/routes/data-transaction.js +120 -0
  93. package/dist/cjs/routes/data-transaction.js.map +1 -0
  94. package/dist/cjs/routes/data-update.js +71 -0
  95. package/dist/cjs/routes/data-update.js.map +1 -0
  96. package/dist/cjs/routes/data.js +63 -0
  97. package/dist/cjs/routes/data.js.map +1 -0
  98. package/dist/cjs/routes/docs.js +249 -0
  99. package/dist/cjs/routes/docs.js.map +1 -0
  100. package/dist/cjs/routes/meta-info.js +70 -0
  101. package/dist/cjs/routes/meta-info.js.map +1 -0
  102. package/dist/cjs/routes/meta-ping.js +12 -0
  103. package/dist/cjs/routes/meta-ping.js.map +1 -0
  104. package/dist/cjs/routes/meta-stats.js +28 -0
  105. package/dist/cjs/routes/meta-stats.js.map +1 -0
  106. package/dist/cjs/routes/meta.js +17 -0
  107. package/dist/cjs/routes/meta.js.map +1 -0
  108. package/dist/cjs/routes/oauth2-init.js +52 -0
  109. package/dist/cjs/routes/oauth2-init.js.map +1 -0
  110. package/dist/cjs/routes/oauth2-refresh.js +43 -0
  111. package/dist/cjs/routes/oauth2-refresh.js.map +1 -0
  112. package/dist/cjs/routes/oauth2-signin.js +262 -0
  113. package/dist/cjs/routes/oauth2-signin.js.map +1 -0
  114. package/dist/cjs/routes/webmanager.js +27 -0
  115. package/dist/cjs/routes/webmanager.js.map +1 -0
  116. package/dist/cjs/rules.js +175 -0
  117. package/dist/cjs/rules.js.map +1 -0
  118. package/dist/cjs/schema/user.js +26 -0
  119. package/dist/cjs/schema/user.js.map +1 -0
  120. package/dist/cjs/server.js +363 -0
  121. package/dist/cjs/server.js.map +1 -0
  122. package/dist/cjs/settings/email.js +5 -0
  123. package/dist/cjs/settings/email.js.map +1 -0
  124. package/dist/cjs/settings/index.js +159 -0
  125. package/dist/cjs/settings/index.js.map +1 -0
  126. package/dist/cjs/shared/clients.js +27 -0
  127. package/dist/cjs/shared/clients.js.map +1 -0
  128. package/dist/cjs/shared/email.js +7 -0
  129. package/dist/cjs/shared/email.js.map +1 -0
  130. package/{src/oauth-providers/oauth-provider.js → dist/cjs/shared/env.js} +3 -0
  131. package/dist/cjs/shared/env.js.map +1 -0
  132. package/dist/cjs/shared/error.js +35 -0
  133. package/dist/cjs/shared/error.js.map +1 -0
  134. package/dist/cjs/shared/http.js +21 -0
  135. package/dist/cjs/shared/http.js.map +1 -0
  136. package/dist/cjs/shared/password.js +46 -0
  137. package/dist/cjs/shared/password.js.map +1 -0
  138. package/dist/cjs/shared/rootpath.js +15 -0
  139. package/dist/cjs/shared/rootpath.js.map +1 -0
  140. package/dist/cjs/shared/signin.js +139 -0
  141. package/dist/cjs/shared/signin.js.map +1 -0
  142. package/dist/cjs/shared/simple-fetch.js +77 -0
  143. package/dist/cjs/shared/simple-fetch.js.map +1 -0
  144. package/dist/cjs/shared/tokens.js +79 -0
  145. package/dist/cjs/shared/tokens.js.map +1 -0
  146. package/dist/cjs/shared/validate.js +62 -0
  147. package/dist/cjs/shared/validate.js.map +1 -0
  148. package/dist/cjs/start.js +51 -0
  149. package/dist/cjs/start.js.map +1 -0
  150. package/dist/cjs/test.js +11 -0
  151. package/dist/cjs/test.js.map +1 -0
  152. package/dist/cjs/websocket/index.js +301 -0
  153. package/dist/cjs/websocket/index.js.map +1 -0
  154. package/dist/cjs/websocket/manager.js +16 -0
  155. package/dist/cjs/websocket/manager.js.map +1 -0
  156. package/dist/cjs/websocket/socket.io.js +79 -0
  157. package/dist/cjs/websocket/socket.io.js.map +1 -0
  158. package/dist/esm/auth.js +76 -0
  159. package/dist/esm/auth.js.map +1 -0
  160. package/{src → dist/esm}/cluster.js +9 -14
  161. package/dist/esm/cluster.js.map +1 -0
  162. package/dist/esm/index.js +3 -0
  163. package/dist/esm/index.js.map +1 -0
  164. package/dist/esm/middleware/404.js +11 -0
  165. package/dist/esm/middleware/404.js.map +1 -0
  166. package/dist/esm/middleware/cache.js +11 -0
  167. package/dist/esm/middleware/cache.js.map +1 -0
  168. package/dist/esm/middleware/connection.js +46 -0
  169. package/dist/esm/middleware/connection.js.map +1 -0
  170. package/dist/esm/middleware/context.js +17 -0
  171. package/dist/esm/middleware/context.js.map +1 -0
  172. package/dist/esm/middleware/cors.js +45 -0
  173. package/dist/esm/middleware/cors.js.map +1 -0
  174. package/dist/esm/middleware/swagger.js +14 -0
  175. package/dist/esm/middleware/swagger.js.map +1 -0
  176. package/dist/esm/middleware/user.js +45 -0
  177. package/dist/esm/middleware/user.js.map +1 -0
  178. package/{src → dist/esm}/oauth-providers/dropbox.js +11 -9
  179. package/dist/esm/oauth-providers/dropbox.js.map +1 -0
  180. package/{src → dist/esm}/oauth-providers/facebook.js +6 -9
  181. package/dist/esm/oauth-providers/facebook.js.map +1 -0
  182. package/{src → dist/esm}/oauth-providers/google.js +8 -11
  183. package/dist/esm/oauth-providers/google.js.map +1 -0
  184. package/dist/esm/oauth-providers/index.js +19 -0
  185. package/dist/esm/oauth-providers/index.js.map +1 -0
  186. package/{src → dist/esm}/oauth-providers/instagram.js +6 -9
  187. package/dist/esm/oauth-providers/instagram.js.map +1 -0
  188. package/dist/esm/oauth-providers/oauth-provider.js +2 -0
  189. package/dist/esm/oauth-providers/oauth-provider.js.map +1 -0
  190. package/{src → dist/esm}/oauth-providers/spotify.js +7 -10
  191. package/dist/esm/oauth-providers/spotify.js.map +1 -0
  192. package/dist/esm/package.json +3 -0
  193. package/dist/esm/routes/auth-change-password.js +70 -0
  194. package/dist/esm/routes/auth-change-password.js.map +1 -0
  195. package/dist/esm/routes/auth-delete.js +36 -0
  196. package/dist/esm/routes/auth-delete.js.map +1 -0
  197. package/dist/esm/routes/auth-forgot-password.js +61 -0
  198. package/dist/esm/routes/auth-forgot-password.js.map +1 -0
  199. package/dist/esm/routes/auth-reset-password.js +78 -0
  200. package/dist/esm/routes/auth-reset-password.js.map +1 -0
  201. package/dist/esm/routes/auth-signin.js +34 -0
  202. package/dist/esm/routes/auth-signin.js.map +1 -0
  203. package/dist/esm/routes/auth-signout.js +46 -0
  204. package/dist/esm/routes/auth-signout.js.map +1 -0
  205. package/dist/esm/routes/auth-signup.js +126 -0
  206. package/dist/esm/routes/auth-signup.js.map +1 -0
  207. package/dist/esm/routes/auth-state.js +13 -0
  208. package/dist/esm/routes/auth-state.js.map +1 -0
  209. package/dist/esm/routes/auth-update.js +115 -0
  210. package/dist/esm/routes/auth-update.js.map +1 -0
  211. package/dist/esm/routes/auth-verify-email.js +52 -0
  212. package/dist/esm/routes/auth-verify-email.js.map +1 -0
  213. package/dist/esm/routes/auth.js +51 -0
  214. package/dist/esm/routes/auth.js.map +1 -0
  215. package/dist/esm/routes/data-exists.js +21 -0
  216. package/dist/esm/routes/data-exists.js.map +1 -0
  217. package/dist/esm/routes/data-export.js +36 -0
  218. package/dist/esm/routes/data-export.js.map +1 -0
  219. package/dist/esm/routes/data-get.js +53 -0
  220. package/dist/esm/routes/data-get.js.map +1 -0
  221. package/dist/esm/routes/data-import.js +42 -0
  222. package/dist/esm/routes/data-import.js.map +1 -0
  223. package/dist/esm/routes/data-index-create.js +31 -0
  224. package/dist/esm/routes/data-index-create.js.map +1 -0
  225. package/dist/esm/routes/data-index-delete.js +23 -0
  226. package/dist/esm/routes/data-index-delete.js.map +1 -0
  227. package/dist/esm/routes/data-index-list.js +22 -0
  228. package/dist/esm/routes/data-index-list.js.map +1 -0
  229. package/dist/esm/routes/data-query.js +57 -0
  230. package/dist/esm/routes/data-query.js.map +1 -0
  231. package/dist/esm/routes/data-reflect.js +76 -0
  232. package/dist/esm/routes/data-reflect.js.map +1 -0
  233. package/dist/esm/routes/data-schema-get.js +26 -0
  234. package/dist/esm/routes/data-schema-get.js.map +1 -0
  235. package/dist/esm/routes/data-schema-set.js +20 -0
  236. package/dist/esm/routes/data-schema-set.js.map +1 -0
  237. package/dist/esm/routes/data-schema-test.js +32 -0
  238. package/dist/esm/routes/data-schema-test.js.map +1 -0
  239. package/dist/esm/routes/data-schemas-list.js +22 -0
  240. package/dist/esm/routes/data-schemas-list.js.map +1 -0
  241. package/dist/esm/routes/data-set.js +57 -0
  242. package/dist/esm/routes/data-set.js.map +1 -0
  243. package/dist/esm/routes/data-sync-changes.js +54 -0
  244. package/dist/esm/routes/data-sync-changes.js.map +1 -0
  245. package/dist/esm/routes/data-sync-mutations.js +54 -0
  246. package/dist/esm/routes/data-sync-mutations.js.map +1 -0
  247. package/dist/esm/routes/data-transaction.js +104 -0
  248. package/dist/esm/routes/data-transaction.js.map +1 -0
  249. package/dist/esm/routes/data-update.js +56 -0
  250. package/dist/esm/routes/data-update.js.map +1 -0
  251. package/dist/esm/routes/data.js +59 -0
  252. package/dist/esm/routes/data.js.map +1 -0
  253. package/dist/esm/routes/docs.js +244 -0
  254. package/dist/esm/routes/docs.js.map +1 -0
  255. package/dist/esm/routes/meta-info.js +66 -0
  256. package/dist/esm/routes/meta-info.js.map +1 -0
  257. package/dist/esm/routes/meta-ping.js +8 -0
  258. package/dist/esm/routes/meta-ping.js.map +1 -0
  259. package/dist/esm/routes/meta-stats.js +15 -0
  260. package/dist/esm/routes/meta-stats.js.map +1 -0
  261. package/dist/esm/routes/meta.js +13 -0
  262. package/dist/esm/routes/meta.js.map +1 -0
  263. package/dist/esm/routes/oauth2-init.js +39 -0
  264. package/dist/esm/routes/oauth2-init.js.map +1 -0
  265. package/dist/esm/routes/oauth2-refresh.js +30 -0
  266. package/dist/esm/routes/oauth2-refresh.js.map +1 -0
  267. package/dist/esm/routes/oauth2-signin.js +248 -0
  268. package/dist/esm/routes/oauth2-signin.js.map +1 -0
  269. package/dist/esm/routes/webmanager.js +23 -0
  270. package/dist/esm/routes/webmanager.js.map +1 -0
  271. package/dist/esm/rules.js +171 -0
  272. package/dist/esm/rules.js.map +1 -0
  273. package/dist/esm/schema/user.js +21 -0
  274. package/dist/esm/schema/user.js.map +1 -0
  275. package/dist/esm/server.js +344 -0
  276. package/dist/esm/server.js.map +1 -0
  277. package/dist/esm/settings/email.js +4 -0
  278. package/dist/esm/settings/email.js.map +1 -0
  279. package/dist/esm/settings/index.js +152 -0
  280. package/dist/esm/settings/index.js.map +1 -0
  281. package/dist/esm/shared/clients.js +23 -0
  282. package/dist/esm/shared/clients.js.map +1 -0
  283. package/dist/esm/shared/email.js +6 -0
  284. package/dist/esm/shared/email.js.map +1 -0
  285. package/dist/esm/shared/env.js +4 -0
  286. package/dist/esm/shared/env.js.map +1 -0
  287. package/dist/esm/shared/error.js +27 -0
  288. package/dist/esm/shared/error.js.map +1 -0
  289. package/dist/esm/shared/http.js +16 -0
  290. package/dist/esm/shared/http.js.map +1 -0
  291. package/dist/esm/shared/password.js +39 -0
  292. package/dist/esm/shared/password.js.map +1 -0
  293. package/dist/esm/shared/rootpath.js +12 -0
  294. package/dist/esm/shared/rootpath.js.map +1 -0
  295. package/dist/esm/shared/signin.js +125 -0
  296. package/dist/esm/shared/signin.js.map +1 -0
  297. package/{src/oauth-providers → dist/esm/shared}/simple-fetch.js +7 -10
  298. package/dist/esm/shared/simple-fetch.js.map +1 -0
  299. package/dist/esm/shared/tokens.js +72 -0
  300. package/dist/esm/shared/tokens.js.map +1 -0
  301. package/dist/esm/shared/validate.js +42 -0
  302. package/dist/esm/shared/validate.js.map +1 -0
  303. package/dist/esm/start.js +48 -0
  304. package/dist/esm/start.js.map +1 -0
  305. package/dist/esm/test.js +9 -0
  306. package/dist/esm/test.js.map +1 -0
  307. package/dist/esm/websocket/index.js +288 -0
  308. package/dist/esm/websocket/index.js.map +1 -0
  309. package/dist/esm/websocket/manager.js +12 -0
  310. package/dist/esm/websocket/manager.js.map +1 -0
  311. package/dist/esm/websocket/socket.io.js +73 -0
  312. package/dist/esm/websocket/socket.io.js.map +1 -0
  313. package/dist/types/auth.d.ts +3 -0
  314. package/dist/types/cluster.d.ts +1 -0
  315. package/dist/types/index.d.ts +2 -0
  316. package/dist/types/middleware/404.d.ts +7 -0
  317. package/dist/types/middleware/cache.d.ts +3 -0
  318. package/dist/types/middleware/connection.d.ts +7 -0
  319. package/dist/types/middleware/context.d.ts +3 -0
  320. package/dist/types/middleware/cors.d.ts +25 -0
  321. package/dist/types/middleware/swagger.d.ts +3 -0
  322. package/dist/types/middleware/user.d.ts +2 -0
  323. package/dist/types/oauth-providers/dropbox.d.ts +63 -0
  324. package/dist/types/oauth-providers/facebook.d.ts +45 -0
  325. package/dist/types/oauth-providers/google.d.ts +47 -0
  326. package/dist/types/oauth-providers/index.d.ts +18 -0
  327. package/dist/types/oauth-providers/instagram.d.ts +54 -0
  328. package/dist/types/oauth-providers/oauth-provider.d.ts +70 -0
  329. package/dist/types/oauth-providers/spotify.d.ts +57 -0
  330. package/dist/types/routes/auth-change-password.d.ts +20 -0
  331. package/dist/types/routes/auth-delete.d.ts +16 -0
  332. package/dist/types/routes/auth-forgot-password.d.ts +16 -0
  333. package/dist/types/routes/auth-reset-password.d.ts +23 -0
  334. package/dist/types/routes/auth-signin.d.ts +24 -0
  335. package/dist/types/routes/auth-signout.d.ts +14 -0
  336. package/dist/types/routes/auth-signup.d.ts +32 -0
  337. package/dist/types/routes/auth-state.d.ts +13 -0
  338. package/dist/types/routes/auth-update.d.ts +33 -0
  339. package/dist/types/routes/auth-verify-email.d.ts +21 -0
  340. package/dist/types/routes/auth.d.ts +6 -0
  341. package/dist/types/routes/data-exists.d.ts +9 -0
  342. package/dist/types/routes/data-export.d.ts +10 -0
  343. package/dist/types/routes/data-get.d.ts +14 -0
  344. package/dist/types/routes/data-import.d.ts +13 -0
  345. package/dist/types/routes/data-index-create.d.ts +51 -0
  346. package/dist/types/routes/data-index-delete.d.ts +17 -0
  347. package/dist/types/routes/data-index-list.d.ts +21 -0
  348. package/dist/types/routes/data-query.d.ts +49 -0
  349. package/dist/types/routes/data-reflect.d.ts +29 -0
  350. package/dist/types/routes/data-schema-get.d.ts +11 -0
  351. package/dist/types/routes/data-schema-set.d.ts +19 -0
  352. package/dist/types/routes/data-schema-test.d.ts +21 -0
  353. package/dist/types/routes/data-schemas-list.d.ts +11 -0
  354. package/dist/types/routes/data-set.d.ts +27 -0
  355. package/dist/types/routes/data-sync-changes.d.ts +28 -0
  356. package/dist/types/routes/data-sync-mutations.d.ts +28 -0
  357. package/dist/types/routes/data-transaction.d.ts +34 -0
  358. package/dist/types/routes/data-update.d.ts +27 -0
  359. package/dist/types/routes/data.d.ts +3 -0
  360. package/dist/types/routes/docs.d.ts +3 -0
  361. package/dist/types/routes/meta-info.d.ts +11 -0
  362. package/dist/types/routes/meta-ping.d.ts +7 -0
  363. package/dist/types/routes/meta-stats.d.ts +13 -0
  364. package/dist/types/routes/meta.d.ts +3 -0
  365. package/dist/types/routes/oauth2-init.d.ts +13 -0
  366. package/dist/types/routes/oauth2-refresh.d.ts +17 -0
  367. package/dist/types/routes/oauth2-signin.d.ts +15 -0
  368. package/dist/types/routes/webmanager.d.ts +3 -0
  369. package/dist/types/rules.d.ts +41 -0
  370. package/dist/types/schema/user.d.ts +85 -0
  371. package/dist/types/server.d.ts +106 -0
  372. package/dist/types/settings/email.d.ts +14 -0
  373. package/dist/types/settings/index.d.ts +165 -0
  374. package/dist/types/shared/clients.d.ts +44 -0
  375. package/dist/types/shared/email.d.ts +34 -0
  376. package/dist/types/shared/env.d.ts +42 -0
  377. package/dist/types/shared/error.d.ts +15 -0
  378. package/dist/types/shared/http.d.ts +14 -0
  379. package/dist/types/shared/password.d.ts +19 -0
  380. package/dist/types/shared/rootpath.d.ts +2 -0
  381. package/dist/types/shared/signin.d.ts +31 -0
  382. package/dist/types/shared/simple-fetch.d.ts +21 -0
  383. package/dist/types/shared/tokens.d.ts +23 -0
  384. package/dist/types/shared/validate.d.ts +22 -0
  385. package/dist/types/start.d.ts +1 -0
  386. package/dist/types/test.d.ts +1 -0
  387. package/dist/types/websocket/index.d.ts +2 -0
  388. package/dist/types/websocket/manager.d.ts +99 -0
  389. package/dist/types/websocket/socket.io.d.ts +10 -0
  390. package/package.json +25 -8
  391. package/src/auth.ts +87 -0
  392. package/src/cluster.ts +62 -0
  393. package/src/index.ts +2 -0
  394. package/src/middleware/404.ts +13 -0
  395. package/src/middleware/cache.ts +15 -0
  396. package/src/middleware/connection.ts +48 -0
  397. package/src/middleware/context.ts +23 -0
  398. package/src/middleware/cors.ts +49 -0
  399. package/src/middleware/swagger.ts +19 -0
  400. package/src/middleware/user.ts +51 -0
  401. package/src/{ts/oauth-providers → oauth-providers}/dropbox.ts +1 -1
  402. package/src/{ts/oauth-providers → oauth-providers}/facebook.ts +1 -1
  403. package/src/{ts/oauth-providers → oauth-providers}/google.ts +1 -1
  404. package/src/oauth-providers/index.ts +20 -0
  405. package/src/{ts/oauth-providers → oauth-providers}/instagram.ts +1 -1
  406. package/src/{ts/oauth-providers → oauth-providers}/oauth-provider.ts +0 -0
  407. package/src/{ts/oauth-providers → oauth-providers}/spotify.ts +1 -1
  408. package/src/routes/auth-change-password.ts +89 -0
  409. package/src/routes/auth-change-password.yaml +74 -0
  410. package/src/routes/auth-delete.ts +47 -0
  411. package/src/routes/auth-delete.yaml +78 -0
  412. package/src/routes/auth-forgot-password.ts +73 -0
  413. package/src/routes/auth-forgot-password.yaml +50 -0
  414. package/src/routes/auth-reset-password.ts +93 -0
  415. package/src/routes/auth-reset-password.yaml +54 -0
  416. package/src/routes/auth-signin.ts +55 -0
  417. package/src/routes/auth-signin.yaml +130 -0
  418. package/src/routes/auth-signout.ts +61 -0
  419. package/src/routes/auth-signout.yaml +46 -0
  420. package/src/routes/auth-signup.ts +161 -0
  421. package/src/routes/auth-signup.yaml +136 -0
  422. package/src/routes/auth-state.ts +20 -0
  423. package/src/routes/auth-state.yaml +29 -0
  424. package/src/routes/auth-update.ts +147 -0
  425. package/src/routes/auth-update.yaml +152 -0
  426. package/src/routes/auth-verify-email.ts +67 -0
  427. package/src/routes/auth-verify-email.yaml +53 -0
  428. package/src/routes/auth.ts +67 -0
  429. package/src/routes/data-exists.ts +31 -0
  430. package/src/routes/data-exists.yaml +44 -0
  431. package/src/routes/data-export.ts +51 -0
  432. package/src/routes/data-export.yaml +64 -0
  433. package/src/routes/data-get.ts +68 -0
  434. package/src/routes/data-get.yaml +54 -0
  435. package/src/routes/data-import.ts +56 -0
  436. package/src/routes/data-import.yaml +75 -0
  437. package/src/routes/data-index-create.ts +85 -0
  438. package/src/routes/data-index-create.yaml +105 -0
  439. package/src/routes/data-index-delete.ts +39 -0
  440. package/src/routes/data-index-delete.yaml +51 -0
  441. package/src/routes/data-index-list.ts +42 -0
  442. package/src/routes/data-index-list.yaml +80 -0
  443. package/src/routes/data-query.ts +97 -0
  444. package/src/routes/data-query.yaml +166 -0
  445. package/src/routes/data-reflect.ts +94 -0
  446. package/src/routes/data-reflect.yaml +124 -0
  447. package/src/routes/data-schema-get.ts +38 -0
  448. package/src/routes/data-schema-get.yaml +53 -0
  449. package/src/routes/data-schema-set.ts +38 -0
  450. package/src/routes/data-schema-set.yaml +60 -0
  451. package/src/routes/data-schema-test.ts +53 -0
  452. package/src/routes/data-schema-test.yaml +66 -0
  453. package/src/routes/data-schemas-list.ts +33 -0
  454. package/src/routes/data-schemas-list.yaml +41 -0
  455. package/src/routes/data-set.ts +76 -0
  456. package/src/routes/data-set.yaml +71 -0
  457. package/src/routes/data-sync-changes.ts +78 -0
  458. package/src/routes/data-sync-changes.yaml +67 -0
  459. package/src/routes/data-sync-mutations.ts +78 -0
  460. package/src/routes/data-sync-mutations.yaml +67 -0
  461. package/src/routes/data-transaction-finish.yaml +76 -0
  462. package/src/routes/data-transaction-start.yaml +58 -0
  463. package/src/routes/data-transaction.ts +144 -0
  464. package/src/routes/data-update.ts +77 -0
  465. package/src/routes/data-update.yaml +71 -0
  466. package/src/routes/data.ts +79 -0
  467. package/src/routes/docs.ts +249 -0
  468. package/src/routes/meta-info.ts +80 -0
  469. package/src/routes/meta-info.yaml +41 -0
  470. package/src/routes/meta-ping.ts +15 -0
  471. package/src/routes/meta-ping.yaml +23 -0
  472. package/src/routes/meta-stats.ts +31 -0
  473. package/src/routes/meta-stats.yaml +41 -0
  474. package/src/routes/meta.ts +18 -0
  475. package/src/routes/oauth2-init.ts +44 -0
  476. package/src/routes/oauth2-init.yaml +63 -0
  477. package/src/routes/oauth2-refresh.ts +39 -0
  478. package/src/routes/oauth2-refresh.yaml +65 -0
  479. package/src/routes/oauth2-signin.ts +281 -0
  480. package/src/routes/oauth2-signin.yaml +66 -0
  481. package/src/routes/webmanager.ts +29 -0
  482. package/src/rules.ts +196 -0
  483. package/src/schema/user.ts +99 -0
  484. package/src/server.ts +416 -0
  485. package/src/settings/email.ts +18 -0
  486. package/src/settings/index.ts +241 -0
  487. package/src/shared/clients.ts +31 -0
  488. package/src/shared/email.ts +33 -0
  489. package/src/shared/env.ts +38 -0
  490. package/src/shared/error.ts +37 -0
  491. package/src/shared/http.ts +24 -0
  492. package/src/shared/password.ts +41 -0
  493. package/src/shared/rootpath.ts +15 -0
  494. package/src/shared/signin.ts +143 -0
  495. package/src/{ts/oauth-providers → shared}/simple-fetch.ts +2 -2
  496. package/src/shared/tokens.ts +77 -0
  497. package/src/shared/validate.ts +53 -0
  498. package/src/{start.js → start.ts} +7 -5
  499. package/src/test.ts +10 -0
  500. package/src/websocket/index.ts +320 -0
  501. package/src/websocket/manager.ts +46 -0
  502. package/src/websocket/socket.io.ts +91 -0
  503. package/tsconfig-cjs.json +10 -0
  504. package/tsconfig.json +13 -5
  505. package/{src/webmanager → webmanager}/index.html +0 -0
  506. package/{src/webmanager → webmanager}/index.js +0 -0
  507. package/src/acebase-server.js +0 -3053
  508. package/src/index.d.ts +0 -212
  509. package/src/index.js +0 -2
@@ -0,0 +1,78 @@
1
+ /auth/{dbname}/delete:
2
+ post:
3
+ tags:
4
+ - auth
5
+ summary: Delete a user account
6
+ description: Deletes an existing user account
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: Account to delete
17
+ content:
18
+ 'text/plain':
19
+ schema:
20
+ type: string
21
+ value: ''
22
+ example: ''
23
+ description: Empty content to delete signed in user account
24
+ 'application/json':
25
+ schema:
26
+ type: object
27
+ properties:
28
+ uid:
29
+ type: string
30
+ description: (admin user only) to delete a specific user account, the target account `uid` must be passed with the request
31
+ example: jpx0k53u0002ecr7s354c51l
32
+ responses:
33
+ 200:
34
+ description: When delete succeeds, it returns the string `"Farewell"`
35
+ content:
36
+ 'text/plain':
37
+ schema:
38
+ type: text
39
+ value: Farewell
40
+ example: Farewell
41
+ 401:
42
+ description: If this is an unauthenticated request (not signed in), `"401 Unauthorized"` is returned
43
+ content:
44
+ 'application/json':
45
+ schema:
46
+ type: object
47
+ properties:
48
+ code:
49
+ type: string
50
+ value: unauthenticated_delete
51
+ message:
52
+ type: string
53
+ value: You are not authorized to perform this operation, your attempt has been logged
54
+ example:
55
+ code: unauthenticated_delete
56
+ message: You are not authorized to perform this operation, your attempt has been logged
57
+ 403:
58
+ description: If a non-admin user tries to update a user's account details, `"403 Forbidden"` is returned
59
+ content:
60
+ 'application/json':
61
+ schema:
62
+ type: object
63
+ properties:
64
+ code:
65
+ type: string
66
+ value: unauthorized_delete
67
+ message:
68
+ type: string
69
+ value: You are not authorized to perform this operation. This attempt has been logged.
70
+ example:
71
+ code: unauthorized_delete
72
+ message: You are not authorized to perform this operation. This attempt has been logged.
73
+ 500:
74
+ description: An unenexpected error occurred on the server
75
+ content:
76
+ 'application/json':
77
+ schema:
78
+ $ref: '#/components/schemas/UnexpectedError'
@@ -0,0 +1,73 @@
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+ import { DbUserAccountDetails } from '../schema/user';
3
+ import { createSignedPublicToken } from '../shared/tokens';
4
+ import { ID } from 'acebase-core';
5
+ import { AceBaseUserResetPasswordEmailRequest } from '../shared/email';
6
+ import { sendBadRequestError, sendUnexpectedError } from '../shared/error';
7
+
8
+ export class ForgotPasswordError extends Error {
9
+ constructor(public code: 'server_email_config'|'invalid_details'|'invalid_email', message: string) {
10
+ super(message);
11
+ }
12
+ }
13
+
14
+ export type RequestQuery = {};
15
+ export type RequestBody = { email: string };
16
+ export type ResponseBody = 'OK' | { code: string; message: string };
17
+ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
18
+
19
+ export const addRoute = (env: RouteInitEnvironment) => {
20
+
21
+ env.app.post(`/auth/${env.db.name}/forgot_password`, async (req: Request, res) => {
22
+
23
+ const details = req.body;
24
+ try {
25
+ if (!env.config.email || typeof env.config.email.send !== 'function') {
26
+ throw new ForgotPasswordError('server_email_config', 'Server email settings have not been configured');
27
+ }
28
+ if (typeof details !== 'object' || typeof details.email !== 'string' || details.email.length === 0) {
29
+ throw new ForgotPasswordError('invalid_details', 'Invalid details');
30
+ }
31
+ const snaps = await env.authRef.query().filter('email', '==', details.email).get();
32
+ if (snaps.length !== 1) {
33
+ throw new ForgotPasswordError('invalid_email', 'Email address not found, or duplicate entries found');
34
+ }
35
+ const snap = snaps[0];
36
+ const user: DbUserAccountDetails = snap.val();
37
+ user.uid = snap.key as string;
38
+ user.password_reset_code = ID.generate();
39
+
40
+ // Request a password reset email to be sent:
41
+ const request: AceBaseUserResetPasswordEmailRequest = {
42
+ type: 'user_reset_password',
43
+ date: new Date(),
44
+ ip: req.ip,
45
+ resetCode: createSignedPublicToken({ uid: user.uid, code: user.password_reset_code }, env.tokenSalt),
46
+ user: {
47
+ email: user.email,
48
+ uid: user.uid,
49
+ username: user.username,
50
+ settings: user.settings,
51
+ displayName: user.display_name
52
+ }
53
+ };
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() });
59
+ res.send('OK');
60
+ }
61
+ 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() });
63
+ if (err.code) {
64
+ sendBadRequestError(res, err);
65
+ }
66
+ else {
67
+ sendUnexpectedError(res, err);
68
+ }
69
+ }
70
+ });
71
+ };
72
+
73
+ export default addRoute;
@@ -0,0 +1,50 @@
1
+ /auth/{dbname}/forgot_password:
2
+ post:
3
+ tags:
4
+ - auth
5
+ summary: Issue a password reset
6
+ description: Issues a password reset for a user that forgot their password. User must have an email address in the database.
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: user details
17
+ content:
18
+ 'application/json':
19
+ schema:
20
+ type: object
21
+ properties:
22
+ email:
23
+ type: string
24
+ description: User's email address. A password reset email will be sent to this address
25
+ required:
26
+ - email
27
+ responses:
28
+ 200:
29
+ description: If a password reset email has been successfully sent, returns the string `"OK"`
30
+ content:
31
+ 'text/plain':
32
+ schema:
33
+ type: 'string'
34
+ value: OK
35
+ description: The string `"OK"`
36
+ 400:
37
+ description: Returns a `"400 Bad Request"` if the server has not been configured properly, or if no or invalid email address was sent with the request
38
+ content:
39
+ 'application/json':
40
+ schema:
41
+ $ref: '#/components/schemas/Error'
42
+ example:
43
+ code: invalid_email
44
+ message: Email address not found, or duplicate entries found
45
+ 500:
46
+ description: An unexpected error occurred
47
+ content:
48
+ 'application/json':
49
+ schema:
50
+ $ref: '#/components/schemas/UnexpectedError'
@@ -0,0 +1,93 @@
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+ import { DbUserAccountDetails } from '../schema/user';
3
+ import { parseSignedPublicToken } from '../shared/tokens';
4
+ import { sendBadRequestError, sendUnexpectedError } from '../shared/error';
5
+ import { createPasswordHash } from '../shared/password';
6
+ import { AceBaseUserResetPasswordSuccessEmailRequest } from '../shared/email';
7
+
8
+ export class ResetPasswordError extends Error {
9
+ constructor(public code: 'invalid_code'|'unknown_user'|'password_requirement_mismatch', message: string) {
10
+ super(message);
11
+ }
12
+ }
13
+
14
+ export type RequestQuery = {};
15
+ export type RequestBody = { code: string; password: string };
16
+ export type ResponseBody = 'OK' | { code: string; message: string };
17
+ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
18
+
19
+ /**
20
+ * Adds the reset_password route and returns the reset function that can be used to manually reset a password
21
+ * @param env environment
22
+ * @returns returns the reset function
23
+ */
24
+ export const addRoute = (env: RouteInitEnvironment) => {
25
+
26
+ const resetPassword = async (clientIp: string, code: string, newPassword: string) => {
27
+ try {
28
+ var verification = parseSignedPublicToken(code, env.tokenSalt);
29
+ }
30
+ catch(err) {
31
+ throw new ResetPasswordError('invalid_code', err.message);
32
+ }
33
+ const snap = await env.authRef.child(verification.uid).get();
34
+ if (!snap.exists()) {
35
+ throw new ResetPasswordError('unknown_user', 'Uknown user');
36
+ }
37
+ const user: DbUserAccountDetails = snap.val();
38
+ user.uid = snap.key as string;
39
+
40
+ if (user.password_reset_code !== verification.code) {
41
+ throw new ResetPasswordError('invalid_code', 'Invalid code');
42
+ }
43
+ if (newPassword.length < 8 || newPassword.includes(' ')) {
44
+ throw new ResetPasswordError('password_requirement_mismatch', 'Password must be at least 8 characters, and cannot contain spaces');
45
+ }
46
+
47
+ // Ok to change password
48
+ const pwd = createPasswordHash(newPassword);
49
+ await snap.ref.update({
50
+ password: pwd.hash,
51
+ password_salt: pwd.salt,
52
+ password_reset_code: null
53
+ })
54
+ // Send confirmation email
55
+ const request: AceBaseUserResetPasswordSuccessEmailRequest = {
56
+ type: 'user_reset_password_success',
57
+ date: new Date(),
58
+ ip: clientIp,
59
+ user: {
60
+ uid: user.uid,
61
+ email: user.email,
62
+ username: user.username,
63
+ displayName: user.display_name,
64
+ settings: user.settings
65
+ }
66
+ };
67
+ env.config.email?.send(request);
68
+ return user;
69
+ };
70
+
71
+ env.app.post(`/auth/${env.db.name}/reset_password`, async (req: Request, res) => {
72
+
73
+ const details = req.body;
74
+ try {
75
+ 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 });
77
+ res.send('OK');
78
+ }
79
+ 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 });
81
+ if (err.code) {
82
+ sendBadRequestError(res, err);
83
+ }
84
+ else {
85
+ sendUnexpectedError(res, err);
86
+ }
87
+ }
88
+ });
89
+
90
+ return resetPassword;
91
+ };
92
+
93
+ export default addRoute;
@@ -0,0 +1,54 @@
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'
@@ -0,0 +1,55 @@
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;
@@ -0,0 +1,130 @@
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'
@@ -0,0 +1,61 @@
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;
@@ -0,0 +1,46 @@
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
+