acebase-server 1.9.1 → 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 (511) 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 +23 -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/{ts/routes → routes}/auth-change-password.yaml +0 -2
  410. package/src/routes/auth-delete.ts +47 -0
  411. package/src/{ts/routes → routes}/auth-delete.yaml +0 -0
  412. package/src/routes/auth-forgot-password.ts +73 -0
  413. package/src/{ts/routes → routes}/auth-forgot-password.yaml +0 -0
  414. package/src/routes/auth-reset-password.ts +93 -0
  415. package/src/{ts/routes → routes}/auth-reset-password.yaml +0 -0
  416. package/src/routes/auth-signin.ts +55 -0
  417. package/src/{ts/routes → routes}/auth-signin.yaml +5 -5
  418. package/src/routes/auth-signout.ts +61 -0
  419. package/src/{ts/routes → routes}/auth-signout.yaml +0 -0
  420. package/src/routes/auth-signup.ts +161 -0
  421. package/src/{ts/routes → routes}/auth-signup.yaml +15 -0
  422. package/src/routes/auth-state.ts +20 -0
  423. package/src/{ts/routes → routes}/auth-state.yaml +0 -0
  424. package/src/routes/auth-update.ts +147 -0
  425. package/src/{ts/routes → routes}/auth-update.yaml +22 -2
  426. package/src/routes/auth-verify-email.ts +67 -0
  427. package/src/{ts/routes → routes}/auth-verify-email.yaml +0 -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/{ts/routes → routes}/oauth2-init.yaml +0 -0
  477. package/src/routes/oauth2-refresh.ts +39 -0
  478. package/src/{ts/routes → routes}/oauth2-refresh.yaml +0 -0
  479. package/src/routes/oauth2-signin.ts +281 -0
  480. package/src/{ts/routes → routes}/oauth2-signin.yaml +0 -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 -3060
  508. package/src/index.d.ts +0 -212
  509. package/src/index.js +0 -2
  510. package/src/routes/docs.js +0 -97
  511. package/src/ts/routes/docs.ts +0 -100
@@ -0,0 +1,281 @@
1
+ import { DataSnapshot, ID } from 'acebase-core';
2
+ import { DbUserAccountDetails } from '../schema/user';
3
+ import { AceBaseUserSignInEmailRequest, AceBaseUserSignupEmailRequest } from '../shared/email';
4
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
5
+ import { createPasswordHash, generatePassword } from '../shared/password';
6
+ import { createPublicAccessToken, createSignedPublicToken, parseSignedPublicToken } from '../shared/tokens';
7
+ import { fetch } from '../shared/simple-fetch';
8
+
9
+ const socketSignInSuccess = `<html><script>window.close()</script><body>Signed in succesfully. You can <a href="javascript:window.close()">close</a> this page</body></html>`;
10
+ const socketSignInFailed = `<html><script>window.close()</script><body>Failed to sign in. You can <a href="javascript:window.close()">close</a> this page</body></html>`;
11
+
12
+ export type RequestQuery = { state: string; code?: string; error?: string; error_reason?: string; error_description?: string };
13
+ export type RequestBody = null;
14
+ export type ResponseBody = string | { code: 'admin_only', message: string };
15
+ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
16
+
17
+ export const addRoute = (env: RouteInitEnvironment) => {
18
+
19
+ env.app.get(`/oauth2/${env.db.name}/signin`, async (req: Request, res) => {
20
+
21
+ // This is where the user is redirected to by the provider after signin or error
22
+ try {
23
+ const state = parseSignedPublicToken(req.query.state, env.tokenSalt);
24
+ if (req.query.error) {
25
+ if (state.flow === 'socket') {
26
+ const client = env.clients.get(state.client_id);
27
+ client.socket.emit('oauth2-signin', { error: req.query.error, reason: req.query.error_reason, description: req.query.error_description, provider: state.provider });
28
+ }
29
+ else {
30
+ const callbackUrl = `${state.callbackUrl}?provider=${state.provider}&error=${req.query.error}&reason=${req.query.error_reason}&description=${req.query.error_description}`;
31
+ res.redirect(callbackUrl);
32
+ }
33
+ return;
34
+ }
35
+
36
+ // Got authorization code
37
+ const authCode = req.query.code;
38
+ const provider = env.authProviders[state.provider];
39
+
40
+ // Get access & refresh tokens
41
+ const tokens = await provider.getAccessToken({ type: 'auth', auth_code: authCode, redirect_url: `${req.protocol}://${req.headers.host}/oauth2/${env.db.name}/signin` });
42
+
43
+ let user_details;
44
+ // TODO: Have we got an id_token?
45
+ // if (tokens.id_token) {
46
+ // // decode, extract user information
47
+ // }
48
+ // else {
49
+ user_details = await provider.getUserInfo(tokens.access_token);
50
+ // }
51
+
52
+ if (user_details.picture && user_details.picture.length > 0) {
53
+ // Download it, convert to base64
54
+ const best = user_details.picture.sort((a,b) => a.width * a.height > b.width * b.height ? -1 : 1)[0]
55
+ try {
56
+ const response = await fetch(best.url);
57
+ const contentType = response.headers.get('Content-Type');
58
+ if (contentType === 'image/png') { //state.provider === 'google' &&
59
+ // Don't accept image/png, because it's probably a placeholder image. Google does this by creating a png with people's initials
60
+ user_details.picture = [];
61
+ return;
62
+ }
63
+ const image = await response.arrayBuffer();
64
+ let buff = Buffer.from(image);
65
+ best.url = `data:${contentType};base64,${buff.toString('base64')}`;
66
+ user_details.picture = [best]; // Only keep the best one
67
+ }
68
+ catch(err) {
69
+ env.debug.warn(`Could not fetch profile picture from "${best.url}": `, err);
70
+ user_details.picture = null;
71
+ }
72
+ }
73
+
74
+ const getProviderSettings = () => {
75
+ // Returns an object with all info (except picture) the provider has about the user
76
+ const settings = {
77
+ [`${state.provider}_id`]: user_details.id,
78
+ [`${state.provider}_email`]: user_details.email,
79
+ [`${state.provider}_email_verified`]: user_details.email_verified,
80
+ [`${state.provider}_name`]: user_details.name,
81
+ [`${state.provider}_display_name`]: user_details.display_name,
82
+ };
83
+ Object.keys(user_details.other).forEach(key => {
84
+ settings[`${state.provider}_${key}`] = user_details.other[key];
85
+ });
86
+ return settings;
87
+ };
88
+ const providerUsername = `${state.provider}:${user_details.id}`;
89
+
90
+ // Check if this user exists in the database
91
+ let snaps: DataSnapshot[];
92
+ let addToExistingAccount = true;
93
+ if (typeof state.uid === 'string') {
94
+ // Use the signed in uid to link this account to. This allows multiple auth provider
95
+ // accounts (with different email addresses) to be linked to the account the user
96
+ // is signed into, and also allows multiple AceBase users to link to the same provider
97
+ // accounts, eg if a client app allows users to link their own account to a shared
98
+ // family Spotify / Dropbox account.
99
+ let snap = await env.authRef.child(state.uid).get();
100
+ if (!snap.exists()) {
101
+ // This is wrong!
102
+ throw new Error(`Invalid uid`);
103
+ }
104
+ snaps = [snap];
105
+ let user = snap.val();
106
+ addToExistingAccount = user.email === user_details.email;
107
+ }
108
+ else {
109
+ const query = env.authRef.query();
110
+ if (user_details.email) {
111
+ query.filter('email', '==', user_details.email);
112
+ }
113
+ else {
114
+ // User did not allow reading e-mail address, or provider does not have one (eg whatsapp?)
115
+ // Switch to using a generated username such as "facebook-3292389234" instead
116
+ query.filter('username', '==', providerUsername);
117
+ }
118
+ snaps = await query.get();
119
+ }
120
+ if (snaps.length === 0 && user_details.email) {
121
+ // Try again with providerUsername, use might previously have denied access to email,
122
+ // and now has granted access. In that case, we'll already have an account with the
123
+ // generated providerUsername
124
+ snaps = await env.authRef.query().filter('username', '==', providerUsername).get();
125
+ }
126
+ let user: DbUserAccountDetails;
127
+ if (snaps.length === 1) {
128
+ const uid = snaps[0].key as string;
129
+ user = snaps[0].val();
130
+ user.uid = uid;
131
+
132
+ if (addToExistingAccount) {
133
+ // Update user details
134
+ user.email_verified = user.email_verified || user_details.email_verified;
135
+ user.email = user.email || user_details.email;
136
+ if (user_details.picture && user_details.picture.length > 0) {
137
+ user.picture = user_details.picture[0];
138
+ }
139
+ await env.authRef.child(uid).update({
140
+ email: user.email || null,
141
+ email_verified: user.email_verified,
142
+ last_signin: new Date(),
143
+ last_signin_ip: req.ip,
144
+ picture: user.picture
145
+ });
146
+ }
147
+ // Add provider details
148
+ await env.authRef.child(uid).child('settings').update(getProviderSettings());
149
+
150
+ // Log success
151
+ env.logRef.push({ action: 'oauth2_signin', success: true, ip: req.ip, date: new Date(), uid });
152
+
153
+ // Cache the user
154
+ env.authCache.set(user.uid, user);
155
+
156
+ // Request signin e-mail to be sent
157
+ const request: AceBaseUserSignInEmailRequest = {
158
+ type: 'user_signin',
159
+ user: {
160
+ uid: user.uid,
161
+ username: user.username,
162
+ email: user.email,
163
+ displayName: user.display_name,
164
+ settings: user.settings
165
+ },
166
+ date: user.created,
167
+ ip: req.ip,
168
+ activationCode: user.email_verified ? null : createSignedPublicToken({ uid: user.uid }, env.tokenSalt),
169
+ emailVerified: user.email_verified,
170
+ provider: state.provider
171
+ };
172
+
173
+ env.config.email?.send(request).catch(err => {
174
+ env.logRef.push({ action: 'oauth2_login_email', success: false, code: 'unexpected', ip: req.ip, date: new Date(), error: err.message, request });
175
+ });
176
+ }
177
+ else if (snaps.length === 0) {
178
+ // User does not exist, create
179
+
180
+ if (!env.config.auth.allowUserSignup) {
181
+ env.logRef.push({ action: 'oauth2_signup', success: false, code: 'user_signup_disabled', provider: state.provider, email: user_details.email, date: new Date() });
182
+ res.statusCode = 403; // Forbidden
183
+ return res.send({ code: 'admin_only', message: 'Only admin is allowed to create users' });
184
+ }
185
+
186
+ // Create user with Generated password
187
+ let pwd = createPasswordHash(generatePassword());
188
+ user = {
189
+ uid: null,
190
+ username: typeof user_details.email === 'undefined' ? providerUsername : null, // provider-accountid usernames for external accounts without email address
191
+ email: user_details.email || null,
192
+ email_verified: user_details.email_verified, // trust provider's verification
193
+ display_name: user_details.display_name,
194
+ password: pwd.hash,
195
+ password_salt: pwd.salt,
196
+ created: new Date(),
197
+ created_ip: req.ip,
198
+ access_token: ID.generate(),
199
+ access_token_created: new Date(),
200
+ last_signin: new Date(),
201
+ last_signin_ip: req.ip,
202
+ picture: user_details.picture && user_details.picture[0],
203
+ settings: getProviderSettings()
204
+ };
205
+
206
+ const userRef = await env.authRef.push(user);
207
+ const uid = userRef.key;
208
+ user.uid = uid;
209
+
210
+ // Log success
211
+ env.logRef.push({ action: 'oauth2_signup', success: true, ip: req.ip, date: new Date(), uid });
212
+
213
+ // Cache the user
214
+ env.authCache.set(user.uid, user);
215
+
216
+ // Request welcome e-mail to be sent
217
+ const request: AceBaseUserSignupEmailRequest = {
218
+ type: 'user_signup',
219
+ user: {
220
+ uid: user.uid,
221
+ username: user.username,
222
+ email: user.email,
223
+ displayName: user.display_name,
224
+ settings: user.settings
225
+ },
226
+ date: user.created,
227
+ ip: user.created_ip,
228
+ activationCode: user.email_verified ? null : createSignedPublicToken({ uid: user.uid }, env.tokenSalt),
229
+ emailVerified: user.email_verified,
230
+ provider: state.provider
231
+ };
232
+
233
+ env.config.email?.send(request).catch(err => {
234
+ env.logRef.push({ action: 'oauth2_signup_email', success: false, code: 'unexpected', ip: req.ip, date: new Date(), error: err.message, request });
235
+ });
236
+ }
237
+ else {
238
+ // More than 1?!!
239
+ if (state.flow === 'socket') {
240
+ const client = env.clients.get(state.client_id);
241
+ client.socket.emit('oauth2-signin', { action: 'error', error: 'account_duplicates' });
242
+ return res.send(socketSignInFailed);
243
+ }
244
+ else {
245
+ const callbackUrl = `${state.callbackUrl}?provider=${state.provider}&error=account_duplicates`;
246
+ return res.redirect(callbackUrl);
247
+ }
248
+ }
249
+
250
+ let result = {
251
+ provider: {
252
+ name: state.provider,
253
+ access_token: tokens.access_token,
254
+ refresh_token: tokens.refresh_token,
255
+ expires_in: tokens.expires_in
256
+ },
257
+ access_token: createPublicAccessToken(user.uid, req.ip, user.access_token, env.tokenSalt),
258
+
259
+ // Disabled sending user details because:
260
+ // 1) they might be too big to send as redirect header,
261
+ // 2) client should verify the sent access token and get user details from the server
262
+ // user: getPublicAccountDetails(user)
263
+ };
264
+
265
+ if (state.flow === 'socket') {
266
+ const client = env.clients.get(state.client_id);
267
+ client.socket.emit('oauth2-signin', { action: 'success', result });
268
+ res.send(socketSignInSuccess);
269
+ }
270
+ else {
271
+ const base64Result = Buffer.from(JSON.stringify(result)).toString('base64');
272
+ const callbackUrl = `${state.callbackUrl}?result=${base64Result}`;
273
+ res.redirect(callbackUrl);
274
+ }
275
+ }
276
+ catch(err) {
277
+ res.status(500).send(err.message);
278
+ }
279
+
280
+ });
281
+ };
File without changes
@@ -0,0 +1,29 @@
1
+ import { RouteInitEnvironment } from "../shared/env";
2
+ import { packageRootPath } from "../shared/rootpath";
3
+ import { join as joinPaths } from 'path'
4
+
5
+ export const addRoutes = (env: RouteInitEnvironment) => {
6
+
7
+ const webManagerDir = `/webmanager/`;
8
+
9
+ // Add redirect from root to webmanager
10
+ env.app.get('/', (req, res) => {
11
+ res.redirect(webManagerDir);
12
+ });
13
+
14
+ // Serve static files from webmanager directory
15
+ env.app.get(`${webManagerDir}*`, (req, res) => {
16
+ const filePath = req.path.slice(webManagerDir.length);
17
+ const assetsPath = joinPaths(packageRootPath, '/webmanager');
18
+ if (filePath.length === 0) {
19
+ // Send default file
20
+ res.sendFile(joinPaths(assetsPath, '/index.html'));
21
+ }
22
+ else {
23
+ res.sendFile(joinPaths(assetsPath, '/', filePath));
24
+ }
25
+ });
26
+
27
+ };
28
+
29
+ export default addRoutes;
package/src/rules.ts ADDED
@@ -0,0 +1,196 @@
1
+ import { AceBase } from 'acebase';
2
+ import { DebugLogger, PathInfo } from 'acebase-core';
3
+ import * as fs from 'fs';
4
+ import { DbUserAccountDetails } from './schema/user';
5
+ import { AUTH_ACCESS_DEFAULT } from './settings';
6
+
7
+ type PathRuleFunction = ((env: any) => boolean) & { getText(): string };
8
+ type PathRules = {} & {
9
+ '.schema'?: string|Object;
10
+ '.read'?: boolean|string|PathRuleFunction;
11
+ '.write'?: boolean|string|PathRuleFunction;
12
+ '.validate'?: string|PathRuleFunction;
13
+ }
14
+ type RulesData = {
15
+ rules: PathRules;
16
+ }
17
+ export type RuleValidationFailCode = 'rule'|'no_rule'|'private'|'exception';
18
+ // type HasAccessResult = { allow: true } | { allow: false; code: RuleValidationFailCode; message: string; rule?: string|boolean; rulePath?: string; details?: any };
19
+ type HasAccessResult = { allow: boolean; code?: RuleValidationFailCode; message?: string; rule?: string|boolean; rulePath?: string; details?: any } & ({ allow: true } | { allow: false; code: RuleValidationFailCode; message: string; rule?: string|boolean; rulePath?: string; details?: any });
20
+
21
+ export class PathBasedRules {
22
+
23
+ private authEnabled: boolean;
24
+ private accessRules: RulesData;
25
+ stop(): void { throw new Error('not started yet'); }
26
+
27
+ constructor(rulesFilePath: string, defaultAccess: AUTH_ACCESS_DEFAULT, env: { debug: DebugLogger, db: AceBase, authEnabled: boolean } ) {
28
+ // Reads rules from a file and monitors it
29
+ // Check if there is a rules file, load it or generate default
30
+
31
+ const readRules = () => {
32
+ try {
33
+ const json = fs.readFileSync(rulesFilePath, 'utf-8');
34
+ const obj = JSON.parse(json);
35
+ if (typeof obj !== 'object' || typeof obj.rules !== 'object') {
36
+ throw new Error(`malformed rules object`);
37
+ }
38
+ return obj;
39
+ }
40
+ catch (err) {
41
+ env.debug.error(`Failed to read rules from "${rulesFilePath}": ${err.message}`);
42
+ return defaultRules;
43
+ }
44
+ };
45
+ const defaultAccessRule = (def => {
46
+ switch (def) {
47
+ case AUTH_ACCESS_DEFAULT.ALLOW_AUTHENTICATED: {
48
+ return 'auth !== null';
49
+ }
50
+ case AUTH_ACCESS_DEFAULT.ALLOW_ALL: {
51
+ return true;
52
+ }
53
+ case AUTH_ACCESS_DEFAULT.DENY_ALL: {
54
+ return false;
55
+ }
56
+ default: {
57
+ env.debug.error(`Unknown defaultAccessRule "${def}"`);
58
+ return false;
59
+ }
60
+ }
61
+ })(defaultAccess);
62
+ const defaultRules:RulesData = {
63
+ rules: {
64
+ ".read": defaultAccessRule,
65
+ ".write": defaultAccessRule
66
+ }
67
+ };
68
+ let accessRules = defaultRules;
69
+ if (!fs.existsSync(rulesFilePath)) {
70
+ // Write defaults
71
+ fs.writeFileSync(rulesFilePath, JSON.stringify(defaultRules, null, 4));
72
+ }
73
+ else {
74
+ accessRules = readRules();
75
+ }
76
+
77
+ // Convert string rules to functions that can be executed
78
+ const processRules = (path: string, parent: any, variables: string[]) => {
79
+ Object.keys(parent).forEach(key => {
80
+ let rule = parent[key];
81
+ if (['.read', '.write', '.validate'].includes(key) && typeof rule === 'string') {
82
+ // Convert to function
83
+ const text = rule;
84
+ rule = eval(`(env => { const { now, root, newData, data, auth, ${variables.join(', ')} } = env; return ${text}; })`);
85
+ rule.getText = () => {
86
+ return text;
87
+ }
88
+ parent[key] = rule;
89
+ }
90
+ else if (key === '.schema') {
91
+ // Add schema
92
+ env.db.schema.set(path, rule)
93
+ .catch(err => {
94
+ env.debug.error(`Error parsing ${path}/.schema: ${err.message}`)
95
+ });
96
+ }
97
+ else if (key.startsWith('$')) {
98
+ variables.push(key);
99
+ }
100
+ if (typeof rule === 'object') {
101
+ processRules(`${path}/${key}`, rule, variables.slice());
102
+ }
103
+ });
104
+ };
105
+ processRules('', accessRules.rules, []);
106
+
107
+ // Watch file for changes
108
+ const wacthFileListener = () => {
109
+ // Reload access rules
110
+ const accessRules = readRules();
111
+ processRules('', accessRules, []);
112
+ this.accessRules = accessRules;
113
+ };
114
+ fs.watchFile(rulesFilePath, wacthFileListener);
115
+ this.stop = () => {
116
+ fs.unwatchFile(rulesFilePath, wacthFileListener);
117
+ }
118
+ process.on('SIGINT', this.stop);
119
+
120
+ this.authEnabled = env.authEnabled;
121
+ this.accessRules = accessRules;
122
+ }
123
+
124
+ /**
125
+ *
126
+ * @param {DbUserAccountDetails} user
127
+ * @param {string} path
128
+ * @param {boolean} [write]
129
+ * @param {(details: { code: string, message: string, [key:string]: any }) => void} denyDetailsCallback
130
+ */
131
+ userHasAccess (user: Pick<DbUserAccountDetails, 'uid'>, path: string, write: boolean = false): HasAccessResult {
132
+ // Process rules, find out if signed in user is allowed to read/write
133
+ // Defaults to false unless a rule is found that tells us otherwise
134
+
135
+ const allow: HasAccessResult = { allow: true };
136
+ if (!this.authEnabled) {
137
+ // Authentication is disabled, anyone can do anything. Not really a smart thing to do!
138
+ return allow;
139
+ }
140
+ else if (user && user.uid === 'admin') {
141
+ // Always allow admin access
142
+ // TODO: implement user.is_admin, so the default admin account can be disabled
143
+ return allow;
144
+ }
145
+ else if (path.startsWith('__')) {
146
+ // NEW: with the auth database now integrated into the main database,
147
+ // deny access to private resources starting with '__' for non-admins
148
+ return { allow: false, code: 'private', message: `Access to private resource "${path}" not allowed` };
149
+ }
150
+
151
+ const env = { now: Date.now(), auth: user || null }; // IDEA: Add functions like "exists" and "value". These will be async (so that requires refactoring) and can be used like "await exists('./shared/' + auth.uid)" and "await value('./writable') === true"
152
+ const pathKeys = PathInfo.getPathKeys(path);
153
+ let rule = this.accessRules.rules;
154
+ let rulePath = [];
155
+ while(true) {
156
+ if (!rule) {
157
+ // TODO: check if this one is redundant with the pathKeys.length === 0 near the end
158
+ return { allow: false, code: 'no_rule', message: `No rules set for requested path "${path}", defaulting to false` };
159
+ }
160
+ let checkRule = write ? rule['.write'] : rule['.read'];
161
+ if (typeof checkRule === 'boolean') {
162
+ if (!checkRule) {
163
+ return { allow: false, code: 'rule', message: `Access denied to path "${path}" by set rule`, rule: checkRule, rulePath: rulePath.join('/') };
164
+ }
165
+ return allow;
166
+ }
167
+ if (typeof checkRule === 'function') {
168
+ try {
169
+ // Execute rule function
170
+ if (!checkRule(env)) {
171
+ return { allow: false, code: 'rule', message: `Access denied to path "${path}" by set rule`, rule: checkRule.getText(), rulePath: rulePath.join('/') };
172
+ }
173
+ return allow;
174
+ }
175
+ catch (err) {
176
+ // If rule execution throws an exception, don't allow. Can happen when rule is "auth.uid === '...'", and auth is null because the user is not signed in
177
+ return { allow: false, code: 'exception', message: `Access denied to path "${path}" by set rule`, rule: checkRule.getText(), rulePath: rulePath.join('/'), details: err };
178
+ }
179
+ }
180
+ if (pathKeys.length === 0) {
181
+ return { allow: false, code: 'no_rule', message: `No rule found for path ${path}` };
182
+ }
183
+ let nextKey = pathKeys.shift();
184
+ // if nextKey is '*' or '$something', rule[nextKey] will be undefined (or match a variable) so there is no
185
+ // need to change things here for usage of wildcard paths in subscriptions
186
+ if (typeof rule[nextKey] === 'undefined') {
187
+ // Check if current rule has a wildcard child
188
+ const wildcardKey = Object.keys(rule).find(key => key ==='*' || key[0] === '$');
189
+ if (wildcardKey) { env[wildcardKey] = nextKey; }
190
+ nextKey = wildcardKey;
191
+ }
192
+ nextKey && rulePath.push(nextKey);
193
+ rule = rule[nextKey];
194
+ }
195
+ }
196
+ }
@@ -0,0 +1,99 @@
1
+ export interface UserProfilePicture {
2
+ width: number;
3
+ height: number;
4
+ url: string;
5
+ }
6
+
7
+ export interface UserSettings {
8
+ [key: string]: string|number|boolean;
9
+ };
10
+
11
+ export type AceBaseUser = ({ username: string } | { email: string }) & {
12
+ uid: string;
13
+ displayName?: string;
14
+ picture?: UserProfilePicture;
15
+ emailVerified: boolean;
16
+ /** ISO date string */
17
+ created: string;
18
+ /** ISO date string */
19
+ prevSignin: string;
20
+ prevSigninIp:string;
21
+ /** ISO date string */
22
+ lastSignin: string;
23
+ lastSigninIp: string;
24
+ changePassword: boolean;
25
+ /** ISO date string */
26
+ changePasswordRequested: string;
27
+ /** ISO date string */
28
+ changePasswordBefore: string;
29
+ settings: UserSettings;
30
+ };
31
+
32
+ export type DbUserAccountDetails = ({ username: string } | { email: string }) & {
33
+ /** uid, not stored in database object (uid is the node's key) */
34
+ uid: string;
35
+ username?: string;
36
+ email?: string;
37
+ /** if the supplied e-mail address has been verified */
38
+ email_verified?: boolean;
39
+ /** if the account has been disabled */
40
+ is_disabled?: boolean;
41
+ /** user's (public) display name */
42
+ display_name?: string;
43
+ /** optional profile picture */
44
+ picture?: UserProfilePicture;
45
+ /** password hash */
46
+ password: string;
47
+ /** random password salt (base64 encoded) used to generate password hash */
48
+ password_salt: string;
49
+ /** Code that allows a user to reset their password with */
50
+ password_reset_code?: string;
51
+ /** TODO: whether the user has to change their password */
52
+ change_password?: boolean;
53
+ /** TODO: date/time the password change was requested */
54
+ change_password_requested?: Date;
55
+ /** TODO: date/time the user must have changed their password */
56
+ change_password_before?: Date;
57
+ /** date/time the account was created */
58
+ created: Date;
59
+ /** creation ip address */
60
+ created_ip?: string;
61
+ /** date/time of last sign in */
62
+ last_signin?: Date;
63
+ /** ip address of last sign in */
64
+ last_signin_ip?: string;
65
+ /** date/time of previous sign in */
66
+ prev_signin?: Date;
67
+ /** ip address of previous sign in */
68
+ prev_signin_ip?: string;
69
+ /** date/time user last signed out */
70
+ last_signout?: Date;
71
+ /** ip address of last sign out */
72
+ last_signout_ip?: string
73
+ /** access token that allows access after signing in */
74
+ access_token?: string;
75
+ /** date/time access token was generateddate/time access token was generated */
76
+ access_token_created?: Date;
77
+ /** additional settings for this user */
78
+ settings: UserSettings;
79
+ };
80
+
81
+ export const getPublicAccountDetails = (account: DbUserAccountDetails): AceBaseUser => {
82
+ return {
83
+ uid: account.uid,
84
+ username: account.username,
85
+ email: account.email,
86
+ displayName: account.display_name,
87
+ picture: account.picture,
88
+ emailVerified: account.email_verified,
89
+ created: account.created?.toISOString(),
90
+ prevSignin: account.prev_signin?.toISOString(),
91
+ prevSigninIp: account.prev_signin_ip,
92
+ lastSignin: account.last_signin?.toISOString(),
93
+ lastSigninIp: account.last_signin_ip,
94
+ changePassword: account.change_password,
95
+ changePasswordRequested: account.change_password_requested?.toISOString(),
96
+ changePasswordBefore: account.change_password_before?.toISOString(),
97
+ settings: account.settings
98
+ };
99
+ }