acebase-server 1.9.0 → 1.10.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (510) hide show
  1. package/create-package-files +12 -0
  2. package/dist/cjs/auth.js +89 -0
  3. package/dist/cjs/auth.js.map +1 -0
  4. package/dist/cjs/cluster.js +57 -0
  5. package/dist/cjs/cluster.js.map +1 -0
  6. package/dist/cjs/index.js +9 -0
  7. package/dist/cjs/index.js.map +1 -0
  8. package/dist/cjs/middleware/404.js +15 -0
  9. package/dist/cjs/middleware/404.js.map +1 -0
  10. package/dist/cjs/middleware/cache.js +15 -0
  11. package/dist/cjs/middleware/cache.js.map +1 -0
  12. package/dist/cjs/middleware/connection.js +50 -0
  13. package/dist/cjs/middleware/connection.js.map +1 -0
  14. package/dist/cjs/middleware/context.js +21 -0
  15. package/dist/cjs/middleware/context.js.map +1 -0
  16. package/dist/cjs/middleware/cors.js +51 -0
  17. package/dist/cjs/middleware/cors.js.map +1 -0
  18. package/dist/cjs/middleware/swagger.js +18 -0
  19. package/dist/cjs/middleware/swagger.js.map +1 -0
  20. package/dist/cjs/middleware/user.js +58 -0
  21. package/dist/cjs/middleware/user.js.map +1 -0
  22. package/dist/cjs/oauth-providers/dropbox.js +109 -0
  23. package/dist/cjs/oauth-providers/dropbox.js.map +1 -0
  24. package/dist/cjs/oauth-providers/facebook.js +85 -0
  25. package/dist/cjs/oauth-providers/facebook.js.map +1 -0
  26. package/dist/cjs/oauth-providers/google.js +125 -0
  27. package/dist/cjs/oauth-providers/google.js.map +1 -0
  28. package/dist/cjs/oauth-providers/index.js +27 -0
  29. package/dist/cjs/oauth-providers/index.js.map +1 -0
  30. package/dist/cjs/oauth-providers/instagram.js +80 -0
  31. package/dist/cjs/oauth-providers/instagram.js.map +1 -0
  32. package/dist/cjs/oauth-providers/oauth-provider.js +3 -0
  33. package/dist/cjs/oauth-providers/oauth-provider.js.map +1 -0
  34. package/dist/cjs/oauth-providers/spotify.js +113 -0
  35. package/dist/cjs/oauth-providers/spotify.js.map +1 -0
  36. package/dist/cjs/package.json +3 -0
  37. package/dist/cjs/routes/auth-change-password.js +85 -0
  38. package/dist/cjs/routes/auth-change-password.js.map +1 -0
  39. package/dist/cjs/routes/auth-delete.js +51 -0
  40. package/dist/cjs/routes/auth-delete.js.map +1 -0
  41. package/dist/cjs/routes/auth-forgot-password.js +75 -0
  42. package/dist/cjs/routes/auth-forgot-password.js.map +1 -0
  43. package/dist/cjs/routes/auth-reset-password.js +94 -0
  44. package/dist/cjs/routes/auth-reset-password.js.map +1 -0
  45. package/dist/cjs/routes/auth-signin.js +47 -0
  46. package/dist/cjs/routes/auth-signin.js.map +1 -0
  47. package/dist/cjs/routes/auth-signout.js +60 -0
  48. package/dist/cjs/routes/auth-signout.js.map +1 -0
  49. package/dist/cjs/routes/auth-signup.js +141 -0
  50. package/dist/cjs/routes/auth-signup.js.map +1 -0
  51. package/dist/cjs/routes/auth-state.js +26 -0
  52. package/dist/cjs/routes/auth-state.js.map +1 -0
  53. package/dist/cjs/routes/auth-update.js +129 -0
  54. package/dist/cjs/routes/auth-update.js.map +1 -0
  55. package/dist/cjs/routes/auth-verify-email.js +67 -0
  56. package/dist/cjs/routes/auth-verify-email.js.map +1 -0
  57. package/dist/cjs/routes/auth.js +55 -0
  58. package/dist/cjs/routes/auth.js.map +1 -0
  59. package/dist/cjs/routes/data-exists.js +34 -0
  60. package/dist/cjs/routes/data-exists.js.map +1 -0
  61. package/dist/cjs/routes/data-export.js +49 -0
  62. package/dist/cjs/routes/data-export.js.map +1 -0
  63. package/dist/cjs/routes/data-get.js +67 -0
  64. package/dist/cjs/routes/data-get.js.map +1 -0
  65. package/dist/cjs/routes/data-import.js +55 -0
  66. package/dist/cjs/routes/data-import.js.map +1 -0
  67. package/dist/cjs/routes/data-index-create.js +45 -0
  68. package/dist/cjs/routes/data-index-create.js.map +1 -0
  69. package/dist/cjs/routes/data-index-delete.js +36 -0
  70. package/dist/cjs/routes/data-index-delete.js.map +1 -0
  71. package/dist/cjs/routes/data-index-list.js +35 -0
  72. package/dist/cjs/routes/data-index-list.js.map +1 -0
  73. package/dist/cjs/routes/data-query.js +71 -0
  74. package/dist/cjs/routes/data-query.js.map +1 -0
  75. package/dist/cjs/routes/data-reflect.js +89 -0
  76. package/dist/cjs/routes/data-reflect.js.map +1 -0
  77. package/dist/cjs/routes/data-schema-get.js +39 -0
  78. package/dist/cjs/routes/data-schema-get.js.map +1 -0
  79. package/dist/cjs/routes/data-schema-set.js +33 -0
  80. package/dist/cjs/routes/data-schema-set.js.map +1 -0
  81. package/dist/cjs/routes/data-schema-test.js +46 -0
  82. package/dist/cjs/routes/data-schema-test.js.map +1 -0
  83. package/dist/cjs/routes/data-schemas-list.js +35 -0
  84. package/dist/cjs/routes/data-schemas-list.js.map +1 -0
  85. package/dist/cjs/routes/data-set.js +72 -0
  86. package/dist/cjs/routes/data-set.js.map +1 -0
  87. package/dist/cjs/routes/data-sync-changes.js +68 -0
  88. package/dist/cjs/routes/data-sync-changes.js.map +1 -0
  89. package/dist/cjs/routes/data-sync-mutations.js +68 -0
  90. package/dist/cjs/routes/data-sync-mutations.js.map +1 -0
  91. package/dist/cjs/routes/data-transaction.js +120 -0
  92. package/dist/cjs/routes/data-transaction.js.map +1 -0
  93. package/dist/cjs/routes/data-update.js +71 -0
  94. package/dist/cjs/routes/data-update.js.map +1 -0
  95. package/dist/cjs/routes/data.js +63 -0
  96. package/dist/cjs/routes/data.js.map +1 -0
  97. package/dist/cjs/routes/docs.js +249 -0
  98. package/dist/cjs/routes/docs.js.map +1 -0
  99. package/dist/cjs/routes/meta-info.js +70 -0
  100. package/dist/cjs/routes/meta-info.js.map +1 -0
  101. package/dist/cjs/routes/meta-ping.js +12 -0
  102. package/dist/cjs/routes/meta-ping.js.map +1 -0
  103. package/dist/cjs/routes/meta-stats.js +28 -0
  104. package/dist/cjs/routes/meta-stats.js.map +1 -0
  105. package/dist/cjs/routes/meta.js +17 -0
  106. package/dist/cjs/routes/meta.js.map +1 -0
  107. package/dist/cjs/routes/oauth2-init.js +52 -0
  108. package/dist/cjs/routes/oauth2-init.js.map +1 -0
  109. package/dist/cjs/routes/oauth2-refresh.js +43 -0
  110. package/dist/cjs/routes/oauth2-refresh.js.map +1 -0
  111. package/dist/cjs/routes/oauth2-signin.js +262 -0
  112. package/dist/cjs/routes/oauth2-signin.js.map +1 -0
  113. package/dist/cjs/routes/webmanager.js +27 -0
  114. package/dist/cjs/routes/webmanager.js.map +1 -0
  115. package/dist/cjs/rules.js +175 -0
  116. package/dist/cjs/rules.js.map +1 -0
  117. package/dist/cjs/schema/user.js +26 -0
  118. package/dist/cjs/schema/user.js.map +1 -0
  119. package/dist/cjs/server.js +363 -0
  120. package/dist/cjs/server.js.map +1 -0
  121. package/dist/cjs/settings/email.js +5 -0
  122. package/dist/cjs/settings/email.js.map +1 -0
  123. package/dist/cjs/settings/index.js +159 -0
  124. package/dist/cjs/settings/index.js.map +1 -0
  125. package/dist/cjs/shared/clients.js +27 -0
  126. package/dist/cjs/shared/clients.js.map +1 -0
  127. package/dist/cjs/shared/email.js +7 -0
  128. package/dist/cjs/shared/email.js.map +1 -0
  129. package/{src/oauth-providers/oauth-provider.js → dist/cjs/shared/env.js} +3 -0
  130. package/dist/cjs/shared/env.js.map +1 -0
  131. package/dist/cjs/shared/error.js +35 -0
  132. package/dist/cjs/shared/error.js.map +1 -0
  133. package/dist/cjs/shared/http.js +21 -0
  134. package/dist/cjs/shared/http.js.map +1 -0
  135. package/dist/cjs/shared/password.js +46 -0
  136. package/dist/cjs/shared/password.js.map +1 -0
  137. package/dist/cjs/shared/rootpath.js +15 -0
  138. package/dist/cjs/shared/rootpath.js.map +1 -0
  139. package/dist/cjs/shared/signin.js +139 -0
  140. package/dist/cjs/shared/signin.js.map +1 -0
  141. package/dist/cjs/shared/simple-fetch.js +77 -0
  142. package/dist/cjs/shared/simple-fetch.js.map +1 -0
  143. package/dist/cjs/shared/tokens.js +79 -0
  144. package/dist/cjs/shared/tokens.js.map +1 -0
  145. package/dist/cjs/shared/validate.js +62 -0
  146. package/dist/cjs/shared/validate.js.map +1 -0
  147. package/dist/cjs/start.js +51 -0
  148. package/dist/cjs/start.js.map +1 -0
  149. package/dist/cjs/test.js +11 -0
  150. package/dist/cjs/test.js.map +1 -0
  151. package/dist/cjs/websocket/index.js +301 -0
  152. package/dist/cjs/websocket/index.js.map +1 -0
  153. package/dist/cjs/websocket/manager.js +16 -0
  154. package/dist/cjs/websocket/manager.js.map +1 -0
  155. package/dist/cjs/websocket/socket.io.js +79 -0
  156. package/dist/cjs/websocket/socket.io.js.map +1 -0
  157. package/dist/esm/auth.js +76 -0
  158. package/dist/esm/auth.js.map +1 -0
  159. package/{src → dist/esm}/cluster.js +9 -14
  160. package/dist/esm/cluster.js.map +1 -0
  161. package/dist/esm/index.js +3 -0
  162. package/dist/esm/index.js.map +1 -0
  163. package/dist/esm/middleware/404.js +11 -0
  164. package/dist/esm/middleware/404.js.map +1 -0
  165. package/dist/esm/middleware/cache.js +11 -0
  166. package/dist/esm/middleware/cache.js.map +1 -0
  167. package/dist/esm/middleware/connection.js +46 -0
  168. package/dist/esm/middleware/connection.js.map +1 -0
  169. package/dist/esm/middleware/context.js +17 -0
  170. package/dist/esm/middleware/context.js.map +1 -0
  171. package/dist/esm/middleware/cors.js +45 -0
  172. package/dist/esm/middleware/cors.js.map +1 -0
  173. package/dist/esm/middleware/swagger.js +14 -0
  174. package/dist/esm/middleware/swagger.js.map +1 -0
  175. package/dist/esm/middleware/user.js +45 -0
  176. package/dist/esm/middleware/user.js.map +1 -0
  177. package/{src → dist/esm}/oauth-providers/dropbox.js +11 -9
  178. package/dist/esm/oauth-providers/dropbox.js.map +1 -0
  179. package/{src → dist/esm}/oauth-providers/facebook.js +6 -9
  180. package/dist/esm/oauth-providers/facebook.js.map +1 -0
  181. package/{src → dist/esm}/oauth-providers/google.js +8 -11
  182. package/dist/esm/oauth-providers/google.js.map +1 -0
  183. package/dist/esm/oauth-providers/index.js +19 -0
  184. package/dist/esm/oauth-providers/index.js.map +1 -0
  185. package/{src → dist/esm}/oauth-providers/instagram.js +6 -9
  186. package/dist/esm/oauth-providers/instagram.js.map +1 -0
  187. package/dist/esm/oauth-providers/oauth-provider.js +2 -0
  188. package/dist/esm/oauth-providers/oauth-provider.js.map +1 -0
  189. package/{src → dist/esm}/oauth-providers/spotify.js +7 -10
  190. package/dist/esm/oauth-providers/spotify.js.map +1 -0
  191. package/dist/esm/package.json +3 -0
  192. package/dist/esm/routes/auth-change-password.js +70 -0
  193. package/dist/esm/routes/auth-change-password.js.map +1 -0
  194. package/dist/esm/routes/auth-delete.js +36 -0
  195. package/dist/esm/routes/auth-delete.js.map +1 -0
  196. package/dist/esm/routes/auth-forgot-password.js +61 -0
  197. package/dist/esm/routes/auth-forgot-password.js.map +1 -0
  198. package/dist/esm/routes/auth-reset-password.js +78 -0
  199. package/dist/esm/routes/auth-reset-password.js.map +1 -0
  200. package/dist/esm/routes/auth-signin.js +34 -0
  201. package/dist/esm/routes/auth-signin.js.map +1 -0
  202. package/dist/esm/routes/auth-signout.js +46 -0
  203. package/dist/esm/routes/auth-signout.js.map +1 -0
  204. package/dist/esm/routes/auth-signup.js +126 -0
  205. package/dist/esm/routes/auth-signup.js.map +1 -0
  206. package/dist/esm/routes/auth-state.js +13 -0
  207. package/dist/esm/routes/auth-state.js.map +1 -0
  208. package/dist/esm/routes/auth-update.js +115 -0
  209. package/dist/esm/routes/auth-update.js.map +1 -0
  210. package/dist/esm/routes/auth-verify-email.js +52 -0
  211. package/dist/esm/routes/auth-verify-email.js.map +1 -0
  212. package/dist/esm/routes/auth.js +51 -0
  213. package/dist/esm/routes/auth.js.map +1 -0
  214. package/dist/esm/routes/data-exists.js +21 -0
  215. package/dist/esm/routes/data-exists.js.map +1 -0
  216. package/dist/esm/routes/data-export.js +36 -0
  217. package/dist/esm/routes/data-export.js.map +1 -0
  218. package/dist/esm/routes/data-get.js +53 -0
  219. package/dist/esm/routes/data-get.js.map +1 -0
  220. package/dist/esm/routes/data-import.js +42 -0
  221. package/dist/esm/routes/data-import.js.map +1 -0
  222. package/dist/esm/routes/data-index-create.js +31 -0
  223. package/dist/esm/routes/data-index-create.js.map +1 -0
  224. package/dist/esm/routes/data-index-delete.js +23 -0
  225. package/dist/esm/routes/data-index-delete.js.map +1 -0
  226. package/dist/esm/routes/data-index-list.js +22 -0
  227. package/dist/esm/routes/data-index-list.js.map +1 -0
  228. package/dist/esm/routes/data-query.js +57 -0
  229. package/dist/esm/routes/data-query.js.map +1 -0
  230. package/dist/esm/routes/data-reflect.js +76 -0
  231. package/dist/esm/routes/data-reflect.js.map +1 -0
  232. package/dist/esm/routes/data-schema-get.js +26 -0
  233. package/dist/esm/routes/data-schema-get.js.map +1 -0
  234. package/dist/esm/routes/data-schema-set.js +20 -0
  235. package/dist/esm/routes/data-schema-set.js.map +1 -0
  236. package/dist/esm/routes/data-schema-test.js +32 -0
  237. package/dist/esm/routes/data-schema-test.js.map +1 -0
  238. package/dist/esm/routes/data-schemas-list.js +22 -0
  239. package/dist/esm/routes/data-schemas-list.js.map +1 -0
  240. package/dist/esm/routes/data-set.js +57 -0
  241. package/dist/esm/routes/data-set.js.map +1 -0
  242. package/dist/esm/routes/data-sync-changes.js +54 -0
  243. package/dist/esm/routes/data-sync-changes.js.map +1 -0
  244. package/dist/esm/routes/data-sync-mutations.js +54 -0
  245. package/dist/esm/routes/data-sync-mutations.js.map +1 -0
  246. package/dist/esm/routes/data-transaction.js +104 -0
  247. package/dist/esm/routes/data-transaction.js.map +1 -0
  248. package/dist/esm/routes/data-update.js +56 -0
  249. package/dist/esm/routes/data-update.js.map +1 -0
  250. package/dist/esm/routes/data.js +59 -0
  251. package/dist/esm/routes/data.js.map +1 -0
  252. package/dist/esm/routes/docs.js +244 -0
  253. package/dist/esm/routes/docs.js.map +1 -0
  254. package/dist/esm/routes/meta-info.js +66 -0
  255. package/dist/esm/routes/meta-info.js.map +1 -0
  256. package/dist/esm/routes/meta-ping.js +8 -0
  257. package/dist/esm/routes/meta-ping.js.map +1 -0
  258. package/dist/esm/routes/meta-stats.js +15 -0
  259. package/dist/esm/routes/meta-stats.js.map +1 -0
  260. package/dist/esm/routes/meta.js +13 -0
  261. package/dist/esm/routes/meta.js.map +1 -0
  262. package/dist/esm/routes/oauth2-init.js +39 -0
  263. package/dist/esm/routes/oauth2-init.js.map +1 -0
  264. package/dist/esm/routes/oauth2-refresh.js +30 -0
  265. package/dist/esm/routes/oauth2-refresh.js.map +1 -0
  266. package/dist/esm/routes/oauth2-signin.js +248 -0
  267. package/dist/esm/routes/oauth2-signin.js.map +1 -0
  268. package/dist/esm/routes/webmanager.js +23 -0
  269. package/dist/esm/routes/webmanager.js.map +1 -0
  270. package/dist/esm/rules.js +171 -0
  271. package/dist/esm/rules.js.map +1 -0
  272. package/dist/esm/schema/user.js +21 -0
  273. package/dist/esm/schema/user.js.map +1 -0
  274. package/dist/esm/server.js +344 -0
  275. package/dist/esm/server.js.map +1 -0
  276. package/dist/esm/settings/email.js +4 -0
  277. package/dist/esm/settings/email.js.map +1 -0
  278. package/dist/esm/settings/index.js +152 -0
  279. package/dist/esm/settings/index.js.map +1 -0
  280. package/dist/esm/shared/clients.js +23 -0
  281. package/dist/esm/shared/clients.js.map +1 -0
  282. package/dist/esm/shared/email.js +6 -0
  283. package/dist/esm/shared/email.js.map +1 -0
  284. package/dist/esm/shared/env.js +4 -0
  285. package/dist/esm/shared/env.js.map +1 -0
  286. package/dist/esm/shared/error.js +27 -0
  287. package/dist/esm/shared/error.js.map +1 -0
  288. package/dist/esm/shared/http.js +16 -0
  289. package/dist/esm/shared/http.js.map +1 -0
  290. package/dist/esm/shared/password.js +39 -0
  291. package/dist/esm/shared/password.js.map +1 -0
  292. package/dist/esm/shared/rootpath.js +12 -0
  293. package/dist/esm/shared/rootpath.js.map +1 -0
  294. package/dist/esm/shared/signin.js +125 -0
  295. package/dist/esm/shared/signin.js.map +1 -0
  296. package/{src/oauth-providers → dist/esm/shared}/simple-fetch.js +7 -10
  297. package/dist/esm/shared/simple-fetch.js.map +1 -0
  298. package/dist/esm/shared/tokens.js +72 -0
  299. package/dist/esm/shared/tokens.js.map +1 -0
  300. package/dist/esm/shared/validate.js +42 -0
  301. package/dist/esm/shared/validate.js.map +1 -0
  302. package/dist/esm/start.js +48 -0
  303. package/dist/esm/start.js.map +1 -0
  304. package/dist/esm/test.js +9 -0
  305. package/dist/esm/test.js.map +1 -0
  306. package/dist/esm/websocket/index.js +288 -0
  307. package/dist/esm/websocket/index.js.map +1 -0
  308. package/dist/esm/websocket/manager.js +12 -0
  309. package/dist/esm/websocket/manager.js.map +1 -0
  310. package/dist/esm/websocket/socket.io.js +73 -0
  311. package/dist/esm/websocket/socket.io.js.map +1 -0
  312. package/dist/types/auth.d.ts +3 -0
  313. package/dist/types/cluster.d.ts +1 -0
  314. package/dist/types/index.d.ts +2 -0
  315. package/dist/types/middleware/404.d.ts +7 -0
  316. package/dist/types/middleware/cache.d.ts +3 -0
  317. package/dist/types/middleware/connection.d.ts +7 -0
  318. package/dist/types/middleware/context.d.ts +3 -0
  319. package/dist/types/middleware/cors.d.ts +25 -0
  320. package/dist/types/middleware/swagger.d.ts +3 -0
  321. package/dist/types/middleware/user.d.ts +2 -0
  322. package/dist/types/oauth-providers/dropbox.d.ts +63 -0
  323. package/dist/types/oauth-providers/facebook.d.ts +45 -0
  324. package/dist/types/oauth-providers/google.d.ts +47 -0
  325. package/dist/types/oauth-providers/index.d.ts +18 -0
  326. package/dist/types/oauth-providers/instagram.d.ts +54 -0
  327. package/dist/types/oauth-providers/oauth-provider.d.ts +70 -0
  328. package/dist/types/oauth-providers/spotify.d.ts +57 -0
  329. package/dist/types/routes/auth-change-password.d.ts +20 -0
  330. package/dist/types/routes/auth-delete.d.ts +16 -0
  331. package/dist/types/routes/auth-forgot-password.d.ts +16 -0
  332. package/dist/types/routes/auth-reset-password.d.ts +23 -0
  333. package/dist/types/routes/auth-signin.d.ts +24 -0
  334. package/dist/types/routes/auth-signout.d.ts +14 -0
  335. package/dist/types/routes/auth-signup.d.ts +32 -0
  336. package/dist/types/routes/auth-state.d.ts +13 -0
  337. package/dist/types/routes/auth-update.d.ts +33 -0
  338. package/dist/types/routes/auth-verify-email.d.ts +21 -0
  339. package/dist/types/routes/auth.d.ts +6 -0
  340. package/dist/types/routes/data-exists.d.ts +9 -0
  341. package/dist/types/routes/data-export.d.ts +10 -0
  342. package/dist/types/routes/data-get.d.ts +14 -0
  343. package/dist/types/routes/data-import.d.ts +13 -0
  344. package/dist/types/routes/data-index-create.d.ts +51 -0
  345. package/dist/types/routes/data-index-delete.d.ts +17 -0
  346. package/dist/types/routes/data-index-list.d.ts +21 -0
  347. package/dist/types/routes/data-query.d.ts +49 -0
  348. package/dist/types/routes/data-reflect.d.ts +29 -0
  349. package/dist/types/routes/data-schema-get.d.ts +11 -0
  350. package/dist/types/routes/data-schema-set.d.ts +19 -0
  351. package/dist/types/routes/data-schema-test.d.ts +21 -0
  352. package/dist/types/routes/data-schemas-list.d.ts +11 -0
  353. package/dist/types/routes/data-set.d.ts +27 -0
  354. package/dist/types/routes/data-sync-changes.d.ts +28 -0
  355. package/dist/types/routes/data-sync-mutations.d.ts +28 -0
  356. package/dist/types/routes/data-transaction.d.ts +34 -0
  357. package/dist/types/routes/data-update.d.ts +27 -0
  358. package/dist/types/routes/data.d.ts +3 -0
  359. package/dist/types/routes/docs.d.ts +3 -0
  360. package/dist/types/routes/meta-info.d.ts +11 -0
  361. package/dist/types/routes/meta-ping.d.ts +7 -0
  362. package/dist/types/routes/meta-stats.d.ts +13 -0
  363. package/dist/types/routes/meta.d.ts +3 -0
  364. package/dist/types/routes/oauth2-init.d.ts +13 -0
  365. package/dist/types/routes/oauth2-refresh.d.ts +17 -0
  366. package/dist/types/routes/oauth2-signin.d.ts +15 -0
  367. package/dist/types/routes/webmanager.d.ts +3 -0
  368. package/dist/types/rules.d.ts +41 -0
  369. package/dist/types/schema/user.d.ts +85 -0
  370. package/dist/types/server.d.ts +106 -0
  371. package/dist/types/settings/email.d.ts +14 -0
  372. package/dist/types/settings/index.d.ts +165 -0
  373. package/dist/types/shared/clients.d.ts +44 -0
  374. package/dist/types/shared/email.d.ts +34 -0
  375. package/dist/types/shared/env.d.ts +42 -0
  376. package/dist/types/shared/error.d.ts +15 -0
  377. package/dist/types/shared/http.d.ts +14 -0
  378. package/dist/types/shared/password.d.ts +19 -0
  379. package/dist/types/shared/rootpath.d.ts +2 -0
  380. package/dist/types/shared/signin.d.ts +31 -0
  381. package/dist/types/shared/simple-fetch.d.ts +21 -0
  382. package/dist/types/shared/tokens.d.ts +23 -0
  383. package/dist/types/shared/validate.d.ts +22 -0
  384. package/dist/types/start.d.ts +1 -0
  385. package/dist/types/test.d.ts +1 -0
  386. package/dist/types/websocket/index.d.ts +2 -0
  387. package/dist/types/websocket/manager.d.ts +99 -0
  388. package/dist/types/websocket/socket.io.d.ts +10 -0
  389. package/package.json +26 -10
  390. package/src/auth.ts +87 -0
  391. package/src/cluster.ts +62 -0
  392. package/src/index.ts +2 -0
  393. package/src/middleware/404.ts +13 -0
  394. package/src/middleware/cache.ts +15 -0
  395. package/src/middleware/connection.ts +48 -0
  396. package/src/middleware/context.ts +23 -0
  397. package/src/middleware/cors.ts +49 -0
  398. package/src/middleware/swagger.ts +19 -0
  399. package/src/middleware/user.ts +51 -0
  400. package/src/{ts/oauth-providers → oauth-providers}/dropbox.ts +1 -1
  401. package/src/{ts/oauth-providers → oauth-providers}/facebook.ts +1 -1
  402. package/src/{ts/oauth-providers → oauth-providers}/google.ts +1 -1
  403. package/src/oauth-providers/index.ts +20 -0
  404. package/src/{ts/oauth-providers → oauth-providers}/instagram.ts +1 -1
  405. package/src/{ts/oauth-providers → oauth-providers}/oauth-provider.ts +0 -0
  406. package/src/{ts/oauth-providers → oauth-providers}/spotify.ts +1 -1
  407. package/src/routes/auth-change-password.ts +89 -0
  408. package/src/{ts/routes → routes}/auth-change-password.yaml +3 -4
  409. package/src/routes/auth-delete.ts +47 -0
  410. package/src/{ts/routes → routes}/auth-delete.yaml +3 -2
  411. package/src/routes/auth-forgot-password.ts +73 -0
  412. package/src/{ts/routes → routes}/auth-forgot-password.yaml +3 -2
  413. package/src/routes/auth-reset-password.ts +93 -0
  414. package/src/{ts/routes → routes}/auth-reset-password.yaml +3 -2
  415. package/src/routes/auth-signin.ts +55 -0
  416. package/src/{ts/routes → routes}/auth-signin.yaml +8 -7
  417. package/src/routes/auth-signout.ts +61 -0
  418. package/src/{ts/routes → routes}/auth-signout.yaml +4 -3
  419. package/src/routes/auth-signup.ts +161 -0
  420. package/src/{ts/routes → routes}/auth-signup.yaml +18 -2
  421. package/src/routes/auth-state.ts +20 -0
  422. package/src/{ts/routes → routes}/auth-state.yaml +3 -2
  423. package/src/routes/auth-update.ts +147 -0
  424. package/src/{ts/routes → routes}/auth-update.yaml +25 -4
  425. package/src/routes/auth-verify-email.ts +67 -0
  426. package/src/{ts/routes → routes}/auth-verify-email.yaml +3 -2
  427. package/src/routes/auth.ts +67 -0
  428. package/src/routes/data-exists.ts +31 -0
  429. package/src/routes/data-exists.yaml +44 -0
  430. package/src/routes/data-export.ts +51 -0
  431. package/src/routes/data-export.yaml +64 -0
  432. package/src/routes/data-get.ts +68 -0
  433. package/src/routes/data-get.yaml +54 -0
  434. package/src/routes/data-import.ts +56 -0
  435. package/src/routes/data-import.yaml +75 -0
  436. package/src/routes/data-index-create.ts +85 -0
  437. package/src/routes/data-index-create.yaml +105 -0
  438. package/src/routes/data-index-delete.ts +39 -0
  439. package/src/routes/data-index-delete.yaml +51 -0
  440. package/src/routes/data-index-list.ts +42 -0
  441. package/src/routes/data-index-list.yaml +80 -0
  442. package/src/routes/data-query.ts +97 -0
  443. package/src/routes/data-query.yaml +166 -0
  444. package/src/routes/data-reflect.ts +94 -0
  445. package/src/routes/data-reflect.yaml +124 -0
  446. package/src/routes/data-schema-get.ts +38 -0
  447. package/src/routes/data-schema-get.yaml +53 -0
  448. package/src/routes/data-schema-set.ts +38 -0
  449. package/src/routes/data-schema-set.yaml +60 -0
  450. package/src/routes/data-schema-test.ts +53 -0
  451. package/src/routes/data-schema-test.yaml +66 -0
  452. package/src/routes/data-schemas-list.ts +33 -0
  453. package/src/routes/data-schemas-list.yaml +41 -0
  454. package/src/routes/data-set.ts +76 -0
  455. package/src/routes/data-set.yaml +71 -0
  456. package/src/routes/data-sync-changes.ts +78 -0
  457. package/src/routes/data-sync-changes.yaml +67 -0
  458. package/src/routes/data-sync-mutations.ts +78 -0
  459. package/src/routes/data-sync-mutations.yaml +67 -0
  460. package/src/routes/data-transaction-finish.yaml +76 -0
  461. package/src/routes/data-transaction-start.yaml +58 -0
  462. package/src/routes/data-transaction.ts +144 -0
  463. package/src/routes/data-update.ts +77 -0
  464. package/src/routes/data-update.yaml +71 -0
  465. package/src/routes/data.ts +79 -0
  466. package/src/routes/docs.ts +249 -0
  467. package/src/routes/meta-info.ts +80 -0
  468. package/src/routes/meta-info.yaml +41 -0
  469. package/src/routes/meta-ping.ts +15 -0
  470. package/src/routes/meta-ping.yaml +23 -0
  471. package/src/routes/meta-stats.ts +31 -0
  472. package/src/routes/meta-stats.yaml +41 -0
  473. package/src/routes/meta.ts +18 -0
  474. package/src/routes/oauth2-init.ts +44 -0
  475. package/src/routes/oauth2-init.yaml +63 -0
  476. package/src/routes/oauth2-refresh.ts +39 -0
  477. package/src/routes/oauth2-refresh.yaml +65 -0
  478. package/src/routes/oauth2-signin.ts +281 -0
  479. package/src/routes/oauth2-signin.yaml +66 -0
  480. package/src/routes/webmanager.ts +29 -0
  481. package/src/rules.ts +196 -0
  482. package/src/schema/user.ts +99 -0
  483. package/src/server.ts +416 -0
  484. package/src/settings/email.ts +18 -0
  485. package/src/settings/index.ts +240 -0
  486. package/src/shared/clients.ts +31 -0
  487. package/src/shared/email.ts +33 -0
  488. package/src/shared/env.ts +38 -0
  489. package/src/shared/error.ts +37 -0
  490. package/src/shared/http.ts +24 -0
  491. package/src/shared/password.ts +41 -0
  492. package/src/shared/rootpath.ts +15 -0
  493. package/src/shared/signin.ts +143 -0
  494. package/src/{ts/oauth-providers → shared}/simple-fetch.ts +2 -2
  495. package/src/shared/tokens.ts +77 -0
  496. package/src/shared/validate.ts +53 -0
  497. package/src/{start.js → start.ts} +7 -5
  498. package/src/test.ts +10 -0
  499. package/src/websocket/index.ts +320 -0
  500. package/src/websocket/manager.ts +46 -0
  501. package/src/websocket/socket.io.ts +91 -0
  502. package/tsconfig-cjs.json +10 -0
  503. package/tsconfig.json +13 -5
  504. package/{src/webmanager → webmanager}/index.html +0 -0
  505. package/{src/webmanager → webmanager}/index.js +0 -0
  506. package/src/acebase-server.js +0 -3056
  507. package/src/index.d.ts +0 -212
  508. package/src/index.js +0 -2
  509. package/src/routes/docs.js +0 -90
  510. package/src/ts/routes/docs.ts +0 -93
@@ -0,0 +1,77 @@
1
+ import * as crypto from 'crypto';
2
+
3
+ export const createPublicAccessToken = (uid: string, ip: string, dbToken: string, password: string) => {
4
+ let obj = {
5
+ t: dbToken,
6
+ c: Date.now(),
7
+ u: uid,
8
+ i: ip
9
+ };
10
+ // let str = JSON.stringify(obj);
11
+ // str = Buffer.from(str).toString('base64');
12
+ // return 'a' + str; // version a
13
+ return 'b' + createSignedPublicToken(obj, password);
14
+ };
15
+
16
+ export const decodePublicAccessToken = (accessToken: string, password: string) : { access_token: string; uid: string; created: number; ip: string } => {
17
+ if (accessToken[0] === 'b') {
18
+ // New signed version
19
+ const obj = parseSignedPublicToken(accessToken.slice(1), password);
20
+ const details = {
21
+ access_token: obj.t,
22
+ uid: obj.u,
23
+ created: obj.c,
24
+ ip: obj.i
25
+ }
26
+ if (!details.access_token || !details.uid || !details.created || !details.ip) {
27
+ throw new Error('Invalid token');
28
+ }
29
+ return details;
30
+ }
31
+ else if (accessToken[0] === 'a') {
32
+ // Old insecure version, previously allowed until August 1, 2020.
33
+ throw new Error('Old token version not allowed');
34
+ }
35
+ }
36
+
37
+
38
+ const getSignature = (content, salt) => {
39
+ // Use fast md5 with salt to sign with. Large salt recommended!!
40
+ return crypto.createHash('md5').update(salt + content).digest('hex');
41
+ }
42
+
43
+ /**
44
+ * Sign objects with an md5 hash. An attacker might base4 decode it and see the content and generated checksum hash,
45
+ * but will need to guess the password used to generate the hash to manipulate it. This is not impossible but will take
46
+ * a very long time when using a large password
47
+ * @param obj data object to sign
48
+ * @param password password to use as salt for the generated md5 hash
49
+ * @returns base64 encoded signed token
50
+ */
51
+ export const createSignedPublicToken = (obj: any, password: string) => {
52
+ const str = JSON.stringify(obj);
53
+ const checksum = getSignature(str, password);
54
+ return Buffer.from(JSON.stringify({ v: 1, cs: checksum, d: str })).toString('base64');
55
+ };
56
+
57
+ /**
58
+ * Parses and validates a signed token that was previouslt generated by `createSignedPublicToken`
59
+ * @param str token previously generated by `createSignedPublicToken`
60
+ * @param password the same password used to create the token with
61
+ * @returns the original data object
62
+ */
63
+ export const parseSignedPublicToken = (str: string, password: string) => {
64
+ const json = Buffer.from(str, 'base64').toString('utf8');
65
+ const obj = JSON.parse(json) as { v: number; cs: string; d: string };
66
+ if (obj.v !== 1) {
67
+ throw new Error(`Unsupported version`);
68
+ }
69
+ if (typeof obj.cs !== 'string' || typeof obj.d !== 'string') {
70
+ throw new Error('Invalid token');
71
+ }
72
+ const checksum = obj.cs;
73
+ if (checksum !== getSignature(obj.d, password)) {
74
+ throw new Error(`compromised object`);
75
+ }
76
+ return JSON.parse(obj.d);
77
+ };
@@ -0,0 +1,53 @@
1
+ import { DataReference } from "acebase-core";
2
+
3
+ export const isValidEmail = (email: string): boolean => {
4
+ return /[a-z0-9_.+]+@([a-z0-9\-]+\.)+[a-z]{2,}/i.test(email);
5
+ };
6
+
7
+ export const isValidNewEmailAddress = async (authRef: DataReference, email: string): Promise<boolean> => {
8
+ const exists = await authRef.query().filter('email', '==', email).exists();
9
+ return !exists;
10
+ };
11
+
12
+ export const isValidNewUsername = async (authRef: DataReference, username): Promise<boolean> => {
13
+ const exists = await authRef.query().filter('username', '==', username).exists();
14
+ return !exists;
15
+ };
16
+
17
+ export const isValidUsername = (username: string): boolean => {
18
+ return username !== 'admin' && typeof username === 'string' && username.length >= 5 && /^[a-z0-9]+$/.test(username);
19
+ };
20
+
21
+ export const isValidDisplayName = (displayName: string): boolean => {
22
+ return typeof displayName === 'string' && displayName.length >= 5;
23
+ };
24
+
25
+ export const isValidPassword = (password: string): boolean => {
26
+ // return typeof password === 'string' && password.length >= 8 && password.indexOf(' ') < 0 && /[0-9]/.test(password) && /[a-z]/.test(password) && /[A-Z]/.test(password);
27
+ return typeof password === 'string' && password.length >= 8 && password.indexOf(' ') < 0; // Let client application set their own password rules. Keep minimum length of 8 and no spaces requirement.
28
+ };
29
+
30
+ export const isValidPicture = (picture: any): boolean => {
31
+ return picture === null || (typeof picture === 'object' && typeof picture.url === 'string' && typeof picture.width === 'number' && typeof picture.height === 'number');
32
+ };
33
+
34
+ export const isValidSettings = (settings: any): boolean => {
35
+ return typeof settings === 'undefined'
36
+ || (
37
+ typeof settings === 'object'
38
+ && Object.keys(settings).length <= 100 // max 100 settings
39
+ && Object.keys(settings).map(key => typeof settings[key]).every(t => ['string','number','boolean'].indexOf(t) >= 0) // only string, number, boolean values
40
+ && Object.keys(settings).filter(key => typeof settings[key] === 'string').every(key => settings[key].length <= 250) // strings values <= 250 chars
41
+ );
42
+ };
43
+
44
+ export type ValidationError<Code> = { code: Code, message: string };
45
+ export const invalidEmailError: ValidationError<'invalid_email'> = { code: 'invalid_email', message: 'Invalid email address' };
46
+ export const invalidUsernameError: ValidationError<'invalid_username'> = { code: 'invalid_username', message: 'Invalid username, must be at least 5 characters and can only contain lowercase characters a-z and 0-9' };
47
+ export const emailExistsError: ValidationError<'email_conflict'> = { code: 'email_conflict', message: 'Account with email address exists already' };
48
+ export const usernameExistsError: ValidationError<'username_conflict'> = { code: 'username_conflict', message: 'Account with username exists already' };
49
+ export const emailOrUsernameExistsError: ValidationError<'conflict'> = { code: 'conflict', message: `Account with username and/or email already exists` };
50
+ export const invalidDisplayNameError: ValidationError<'invalid_display_name'> = { code: 'invalid_display_name', message: 'Invalid display_name, must be at least 5 characters' };
51
+ export const invalidPasswordError: ValidationError<'invalid_password'> = { code: 'invalid_password', message: 'Invalid password, must be at least 8 characters and cannot contain spaces' };
52
+ export const invalidPictureError: ValidationError<'invalid_picture'> = { code: 'invalid_picture', message: 'Invalid picture, must be an object with url, width and height properties'};
53
+ export const invalidSettingsError: ValidationError<'invalid_settings'> = { code: 'invalid_settings', message: 'Invalid settings, must be an object and contain only string, number and/or boolean values. Additionaly, string values can have a maximum length of 250, and a maximum of 100 settings can be added' };
@@ -1,7 +1,8 @@
1
- const { AceBaseServer } = require('./acebase-server');
1
+ import { AceBaseServer } from './server';
2
+ import { AceBaseServerSettings } from './settings';
2
3
 
3
4
  // If one executes "node start.js [dbname=name] [host=ip] [port=nr]"
4
- function getVariable(name, defaultValue) {
5
+ function getVariable(name: string, defaultValue?: any) {
5
6
  // Checks if an argument with the name was passed,
6
7
  // or if an environment variable was set with that name,
7
8
  // else it will return the default value
@@ -10,14 +11,14 @@ function getVariable(name, defaultValue) {
10
11
  if (arg) { return arg.split('=')[1]; }
11
12
  if (typeof process.env[name] !== 'undefined') { return process.env[name]; }
12
13
  return defaultValue;
13
- }
14
+ };
14
15
 
15
16
  const path = getVariable('DBPATH', '.');
16
17
  const dbname = getVariable('DBNAME', 'default');
17
- const host = getVariable('HOST', '0.0.0.0');
18
+ const host = getVariable('HOST', 'localhost'); // '0.0.0.0'
18
19
  const port = +getVariable('PORT', 3000);
19
20
  const ipcPort = +getVariable('IPC_PORT', 0);
20
- const options = { host, port, path };
21
+ const options: AceBaseServerSettings = { host, port, path };
21
22
  if (ipcPort > 0) {
22
23
  const role = getVariable('IPC_ROLE');
23
24
  if (!['master','worker'].includes(role)) {
@@ -40,4 +41,5 @@ if (+getVariable('TXLOG', 0) === 1) {
40
41
  const server = new AceBaseServer(dbname, options);
41
42
  server.once("ready", () => {
42
43
  server.debug.log(`AceBase server running`);
44
+ process.send?.('ready'); // When using pm2, you can use --wait-ready flag (see https://pm2.keymetrics.io/docs/usage/signals-clean-restart/)
43
45
  });
package/src/test.ts ADDED
@@ -0,0 +1,10 @@
1
+ // Starts a test server for debugging sessions
2
+ import { AceBaseServer } from './server';
3
+
4
+ // Make sure development environment is set
5
+ process.env.NODE_ENV = 'development';
6
+
7
+ const server = new AceBaseServer('default', { logLevel: 'verbose', host: 'localhost', port: 3000, path: '.' });
8
+ server.once('ready', () => {
9
+ console.log(`Ready to debug!`);
10
+ });
@@ -0,0 +1,320 @@
1
+ import { ColorStyle, Transport } from "acebase-core";
2
+ import { EventSubscriptionCallback } from "acebase-core/src/api";
3
+ import { ConnectedClient } from "../shared/clients";
4
+ import { RouteInitEnvironment } from "../shared/env";
5
+ import { decodePublicAccessToken } from "../shared/tokens";
6
+ import { createServer, SocketType } from "./socket.io";
7
+
8
+ export const addWebsocketServer = (env: RouteInitEnvironment) => {
9
+
10
+ // TODO: Allow using uWebSockets.js server instead of Socket.IO
11
+ const serverManager = createServer(env);
12
+
13
+ const getClientBySocketId = (id: string, event: string) => {
14
+ const client = env.clients.get(id);
15
+ if (!client) {
16
+ env.debug.error(`Cannot find client "${id}" for socket event "${event}"`);
17
+ }
18
+ return client;
19
+ };
20
+
21
+ serverManager.on('connect', event => {
22
+ const client = new ConnectedClient(event.socket);
23
+ env.clients.set(client.id, client);
24
+
25
+ env.debug.warn(`New socket connected, total: ${env.clients.size}`);
26
+ serverManager.send(event.socket, 'welcome');
27
+ });
28
+
29
+ serverManager.on('disconnect', event => {
30
+ // We lost one
31
+ const client = getClientBySocketId(event.socket_id, 'disconnect');
32
+ if (!client) { return; } // Disconnected a client we did not know? Don't crash, just ignore.
33
+
34
+ const subscribedPaths = Object.keys(client.subscriptions);
35
+ if (subscribedPaths.length > 0) {
36
+ // TODO: Substitute the original callbacks to cache them
37
+ // if the client then reconnects within a certain time,
38
+ // we can send the missed notifications
39
+ //
40
+ // subscribedPaths.forEach(path => {
41
+ // client.subscriptions[path].forEach(subscr => {
42
+ // subscr.callback
43
+ // })
44
+ // });
45
+
46
+ let remove: {
47
+ path: string;
48
+ event: string;
49
+ callback: EventSubscriptionCallback;
50
+ }[] = [];
51
+ subscribedPaths.forEach(path => {
52
+ remove.push(...client.subscriptions[path]);
53
+ });
54
+ remove.forEach(subscr => {
55
+ // Unsubscribe them at db level and remove from our list
56
+ env.db.api.unsubscribe(subscr.path, subscr.event, subscr.callback); //db.ref(subscr.path).off(subscr.event, subscr.callback);
57
+ let pathSubs = client.subscriptions[subscr.path];
58
+ pathSubs.splice(pathSubs.indexOf(subscr), 1);
59
+ });
60
+ }
61
+ env.clients.delete(client.id);
62
+ env.debug.verbose(`Socket disconnected, total: ${env.clients.size}`);
63
+ });
64
+
65
+ serverManager.on('signin', event => {
66
+ // client sends this request once user has been signed in, binds the user to the socket,
67
+ // deprecated since client v0.9.4, which sends client_id with signin api call
68
+ // const client = clients.get(socket.id);
69
+ const client = getClientBySocketId(event.socket_id, 'signin');
70
+ if (!client) { return; }
71
+
72
+ try {
73
+ const uid = decodePublicAccessToken(event.data.accessToken, env.tokenSalt).uid;
74
+ client.user = env.authCache.get(uid) || null;
75
+ }
76
+ catch(err) {
77
+ // no way to bind the user
78
+ env.debug.error(`websocket: invalid access token passed to signin: ${event.data.accessToken}`);
79
+ }
80
+ });
81
+
82
+ serverManager.on('signout', event => {
83
+ // deprecated since client v0.9.4, which sends client_id with signout api call
84
+ // const client = clients.get(socket.id);
85
+ const client = getClientBySocketId(event.socket_id, 'signout');
86
+ if (!client) { return; }
87
+ client.user = null;
88
+ });
89
+
90
+ serverManager.on('oauth2-signin', async event => {
91
+ // acebase-client does not use socket oauth flow yet
92
+ const client = getClientBySocketId(event.socket_id, 'oauth2-signin');
93
+ if (!client) { return; }
94
+
95
+ const request = event.data;
96
+ const providerName = typeof request === 'string' ? request : request.provider;
97
+ try {
98
+ const provider = env.authProviders[providerName];
99
+ const state = Buffer.from(JSON.stringify({ flow: 'socket', provider: providerName, client_id: client.id })).toString('base64');
100
+ const clientAuthUrl = await provider.init({ redirect_url: `${request.server.protocol}://${request.server.host}:${request.server.port}/ouath2/${env.db.name}/signin`, state, options: request.options });
101
+
102
+ serverManager.send(event.socket, 'oauth2-signin', { action: 'auth', url: clientAuthUrl });
103
+ }
104
+ catch(err) {
105
+ env.debug.error(`websocket: cannot sign in with oauth provider ${providerName}`);
106
+ serverManager.send(event.socket, 'oauth2-signin', { error: err.message });
107
+ }
108
+ });
109
+
110
+ const acknowlegdeRequest = (socket: SocketType, requestId: string) => {
111
+ // Send acknowledgement
112
+ serverManager.send(socket, 'result', {
113
+ success: true,
114
+ req_id: requestId
115
+ });
116
+ };
117
+ const failRequest = (socket: SocketType, requestId: string, code: string) => {
118
+ // Send error
119
+ serverManager.send(socket, 'result', {
120
+ success: false,
121
+ reason: code,
122
+ req_id: requestId
123
+ });
124
+ };
125
+
126
+ serverManager.on('subscribe', event => {
127
+ // Client wants to subscribe to events on a node
128
+ const client = getClientBySocketId(event.socket_id, 'subscribe');
129
+ if (!client) { return; }
130
+
131
+ env.debug.verbose(`Client ${event.socket_id} subscribes to event "${event.data.event}" on path "/${event.data.path}"`.colorize([ColorStyle.bgWhite, ColorStyle.black]));
132
+ const subscriptionPath = event.data.path;
133
+ const isSubscribed = () => subscriptionPath in client.subscriptions && client.subscriptions[subscriptionPath].some(s => s.event === event.data.event)
134
+ if (isSubscribed()) {
135
+ return acknowlegdeRequest(event.socket, event.data.req_id);
136
+ }
137
+
138
+ // Get client
139
+ // const client = clients.get(socket.id);
140
+
141
+ if (!env.rules.userHasAccess(client.user, subscriptionPath, false)) {
142
+ env.logRef.push({ action: 'subscribe', success: false, code: 'access_denied', uid: client.user ? client.user.uid : '-', path: subscriptionPath });
143
+ return failRequest(event.socket, event.data.req_id, 'access_denied');
144
+ }
145
+
146
+ const callback = (err, path: string, currentValue: any, previousValue: any, context: any) => {
147
+ if (!isSubscribed()) {
148
+ // Not subscribed anymore. Cancel sending
149
+ return;
150
+ }
151
+ if (!env.rules.userHasAccess(client.user, path, false)) {
152
+ if (!subscriptionPath.includes('*') && !subscriptionPath.includes('$')) {
153
+ // Could potentially be very many callbacks, so
154
+ // DISABLED: logRef.push({ action: `access_revoked`, uid: client.user ? client.user.uid : '-', path: subscriptionPath });
155
+ // Only log when user subscribes again
156
+ failRequest(event.socket, event.data.req_id, 'access_denied');
157
+ }
158
+ return;
159
+ }
160
+ if (err) {
161
+ return;
162
+ }
163
+ let val = Transport.serialize({
164
+ current: currentValue,
165
+ previous: previousValue
166
+ });
167
+ env.debug.verbose(`Sending data event "${event.data.event}" for path "/${path}" to client ${event.socket_id}`.colorize([ColorStyle.bgWhite, ColorStyle.black]));
168
+ // TODO: let large data events notify the client, then let them download the data manually so it doesn't have to be transmitted through the websocket
169
+ serverManager.send(event.socket, 'data-event', {
170
+ subscr_path: subscriptionPath,
171
+ path,
172
+ event: event.data.event,
173
+ val,
174
+ context
175
+ });
176
+ };
177
+
178
+ let pathSubs = client.subscriptions[subscriptionPath];
179
+ if (!pathSubs) { pathSubs = client.subscriptions[subscriptionPath] = []; }
180
+
181
+ let subscr = { path: subscriptionPath, event: event.data.event, callback };
182
+ pathSubs.push(subscr);
183
+
184
+ env.db.api.subscribe(subscriptionPath, event.data.event, callback);
185
+
186
+ acknowlegdeRequest(event.socket, event.data.req_id);
187
+ });
188
+
189
+ serverManager.on('unsubscribe', event => {
190
+ // Client unsubscribes from events on a node
191
+ const client = getClientBySocketId(event.socket_id, 'unsubscribe');
192
+ if (!client) { return; }
193
+
194
+ env.debug.verbose(`Client ${event.socket_id} is unsubscribing from event "${event.data.event || '(any)'}" on path "/${event.data.path}"`.colorize([ColorStyle.bgWhite, ColorStyle.black]));
195
+
196
+ // const client = clients.get(socket.id);
197
+ let pathSubs = client.subscriptions[event.data.path];
198
+ if (!pathSubs) {
199
+ // We have no knowledge of any active subscriptions on this path
200
+ return acknowlegdeRequest(event.socket, event.data.req_id);
201
+ }
202
+ let remove = pathSubs;
203
+ if (event.data.event) {
204
+ // Unsubscribe from a specific event
205
+ remove = pathSubs.filter(subscr => subscr.event === event.data.event);
206
+ }
207
+ remove.forEach(subscr => {
208
+ // Unsubscribe them at db level and remove from our list
209
+ //this.debug.verbose(` - unsubscribing from event ${subscr.event} with${subscr.callback ? "" : "out"} callback on path "${data.path}"`);
210
+ env.db.api.unsubscribe(subscr.path, subscr.event, subscr.callback); //db.api.unsubscribe(data.path, subscr.event, subscr.callback);
211
+ pathSubs.splice(pathSubs.indexOf(subscr), 1);
212
+ });
213
+ if (pathSubs.length === 0) {
214
+ // No subscriptions left on this path, remove the path entry
215
+ delete client.subscriptions[event.data.path];
216
+ }
217
+ return acknowlegdeRequest(event.socket, event.data.req_id);
218
+ });
219
+
220
+ serverManager.on('query-unsubscribe', event => {
221
+ // Client unsubscribing from realtime query events
222
+ const client = getClientBySocketId(event.socket_id, 'query-unsubscribe');
223
+ if (!client) { return; }
224
+
225
+ env.debug.verbose(`Client ${event.socket_id} is unsubscribing from realtime query "${event.data.query_id}"`);
226
+ // const client = clients.get(socket.id);
227
+ delete client.realtimeQueries[event.data.query_id];
228
+
229
+ acknowlegdeRequest(event.socket, event.data.req_id);
230
+ });
231
+
232
+ const TRANSACTION_TIMEOUT_MS = 10000; // 10s to finish a started transaction
233
+
234
+ serverManager.on('transaction-start', event => {
235
+ // Start transaction
236
+ const client = getClientBySocketId(event.socket_id, 'transaction-start');
237
+ if (!client) { return; }
238
+
239
+ env.debug.verbose(`Client ${event.socket_id} is sending transaction start request on path "${event.data.path}"`);
240
+ const data = event.data;
241
+ const tx = {
242
+ id: data.id,
243
+ started: Date.now(),
244
+ path: data.path,
245
+ context: data.context,
246
+ finish: undefined,
247
+ timeout: setTimeout(() => {
248
+ delete client.transactions[tx.id];
249
+ tx.finish(); // Finish without value cancels the transaction
250
+ serverManager.send(event.socket, 'tx_error', { id: tx.id, reason: 'timeout' });
251
+ }, TRANSACTION_TIMEOUT_MS)
252
+ };
253
+
254
+ if (!env.rules.userHasAccess(client.user, data.path, true)) {
255
+ // throw new AccessDeniedError(`access_denied`);
256
+ return serverManager.send(event.socket, 'tx_error', { id: tx.id, reason: 'access_denied' });
257
+ }
258
+
259
+ // Bind to client
260
+ client.transactions[data.id] = tx;
261
+
262
+ // Start transaction
263
+ env.debug.verbose(`Transaction ${tx.id} starting...`);
264
+
265
+ const donePromise = env.db.api.transaction(tx.path, val => {
266
+ env.debug.verbose(`Transaction ${tx.id} started with value: `, val);
267
+
268
+ const currentValue = Transport.serialize(val);
269
+ const promise = new Promise((resolve) => {
270
+ tx.finish = (val?: any) => {
271
+ env.debug.verbose(`Transaction ${tx.id} finishing with value: `, val);
272
+ resolve(val);
273
+ return donePromise;
274
+ };
275
+ });
276
+
277
+ serverManager.send(event.socket, 'tx_started', { id: tx.id, value: currentValue });
278
+ return promise;
279
+ }, { context: tx.context });
280
+ });
281
+
282
+ serverManager.on('transaction-finish', async event => {
283
+ // Finish transaction
284
+ const client = getClientBySocketId(event.socket_id, 'transaction-finish');
285
+ if (!client) { return; }
286
+
287
+ const data = event.data;
288
+ const tx = client.transactions[data.id];
289
+
290
+ try {
291
+ if (!tx || data.path !== tx.path) {
292
+ throw new Error('transaction_not_found');
293
+ }
294
+
295
+ clearTimeout(tx.timeout);
296
+ delete client.transactions[data.id];
297
+
298
+ if (!env.rules.userHasAccess(client.user, data.path, true)) {
299
+ throw new Error('access_denied');
300
+ }
301
+
302
+ const newValue = Transport.deserialize(data.value);
303
+ try {
304
+ await tx.finish(newValue);
305
+ env.debug.verbose(`Transaction ${tx.id} finished`);
306
+ serverManager.send(event.socket, 'tx_completed', { id: tx.id });
307
+ }
308
+ catch (err) {
309
+ serverManager.send(event.socket, 'tx_error', { id: tx.id, reason: err.message });
310
+ }
311
+ }
312
+ catch (err) {
313
+ serverManager.send(event.socket, 'tx_error', { id: tx.id, reason: err.message, data });
314
+ tx.finish(); // Finish with undefined, canceling the transaction
315
+ }
316
+
317
+ });
318
+
319
+ return serverManager;
320
+ }
@@ -0,0 +1,46 @@
1
+ import { SimpleEventEmitter } from "acebase-core";
2
+
3
+ export type WebSocketEventData<SocketType, DataType = undefined> = {
4
+ socket: SocketType;
5
+ socket_id: string;
6
+ data?: DataType;
7
+ }
8
+ export type WebSocketEventCallback<SocketType, DataType = any> = (event: WebSocketEventData<SocketType, DataType>) => void;
9
+
10
+ export abstract class WebSocketManager<SocketType> extends SimpleEventEmitter {
11
+ constructor(public readonly framework: string) {
12
+ super();
13
+ }
14
+ abstract disconnect(socket: SocketType): any;
15
+ abstract send(socket: SocketType, event: string, message: any): any;
16
+
17
+ on(event: 'connect', callback: WebSocketEventCallback<SocketType>): void;
18
+ on(event: 'disconnect', callback: WebSocketEventCallback<SocketType>): void;
19
+ /** @deprecated deprecated since client v0.9.4 */
20
+ on(event: 'signin', callback: WebSocketEventCallback<SocketType, { accessToken: string }>): void;
21
+ /** @deprecated deprecated since client v0.9.4 */
22
+ on(event: 'signout', callback: WebSocketEventCallback<SocketType>): void;
23
+ on(event: 'oauth2-signin', callback: WebSocketEventCallback<SocketType, { server: { protocol: 'http'|'https', host: string, port: number }; provider: string; options: any }>): void;
24
+ on(event: 'subscribe', callback: WebSocketEventCallback<SocketType, { req_id: string; path: string; event: string }>): void;
25
+ on(event: 'unsubscribe', callback: WebSocketEventCallback<SocketType, { req_id: string; path: string; event?: string }>): void;
26
+ on(event: 'query-unsubscribe', callback: WebSocketEventCallback<SocketType, { req_id: string; query_id: string }>): void;
27
+ on(event: 'transaction-start', callback: WebSocketEventCallback<SocketType, { action: 'start', id: string; path: string; context: any }>): void;
28
+ on(event: 'transaction-finish', callback: WebSocketEventCallback<SocketType, { action: 'finish', id: string; path: string; value: any }>): void;
29
+ on(event: string, callback: (data: any) => void) {
30
+ super.on(event, callback);
31
+ }
32
+
33
+ emit(event: 'connect', data: WebSocketEventData<SocketType>): void;
34
+ emit(event: 'disconnect', data: WebSocketEventData<SocketType>): void;
35
+ /** @deprecated deprecated since client v0.9.4 */
36
+ emit(event: 'signin', data: WebSocketEventData<SocketType, { accessToken: string }>): void;
37
+ /** @deprecated deprecated since client v0.9.4 */
38
+ emit(event: 'signout', data: WebSocketEventData<SocketType>): void;
39
+ emit(event: 'oauth2-signin', data: WebSocketEventData<SocketType, { server: { protocol: 'http'|'https', host: string, port: number }; provider: string; options: any }>): void;
40
+ emit(event: 'subscribe', data: WebSocketEventData<SocketType, { req_id: string; path: string; event: string }>): void;
41
+ emit(event: 'unsubscribe', data: WebSocketEventData<SocketType, { req_id: string; path: string; event?: string }>): void;
42
+ emit(event: 'query-unsubscribe', data: WebSocketEventData<SocketType, { req_id: string; query_id: string }>): void;
43
+ emit(event: 'transaction-start', data: WebSocketEventData<SocketType, { action: 'start', id: string; path: string; context: any }>): void;
44
+ emit(event: 'transaction-finish', data: WebSocketEventData<SocketType, { action: 'finish', id: string; path: string; value: any }>): void;
45
+ emit(event: string, data: any) { super.emit(event, data); }
46
+ }
@@ -0,0 +1,91 @@
1
+ import * as socketIO from 'socket.io';
2
+ const createSocketIOServer = (socketIO as any).default ?? socketIO; // ESM and CJS compatible approach
3
+
4
+ import type { Socket } from 'socket.io';
5
+ import { RouteInitEnvironment } from '../shared/env';
6
+ import { IncomingMessage } from 'http';
7
+ import { WebSocketManager } from './manager';
8
+ import { getCorsHeaders, getCorsOptions } from '../middleware/cors';
9
+
10
+ export type SocketType = Socket;
11
+ export class SocketIOManager extends WebSocketManager<Socket> {
12
+ constructor() {
13
+ super('Socket.IO');
14
+ }
15
+ disconnect(socket: Socket) {
16
+ socket.disconnect(true);
17
+ }
18
+ send(socket: Socket, event: string, message?: any) {
19
+ socket.emit(event, message);
20
+ }
21
+ }
22
+
23
+ export const createServer = (env: RouteInitEnvironment) => {
24
+
25
+
26
+ // TODO: determine max socket payload using env.config.maxPayloadSize which is now only used for json POST data
27
+ // const maxPayloadBytes = ((payloadStr) => {
28
+ // const match = payloadStr.match(/^([0-9]+)(?:mb|kb|b)$/i);
29
+ // if (!match) { return 10e7; } // Socket.IO 2.x default (100MB), 3.x default is 1MB (1e6)
30
+ // const nr = +match[0], unit = match[1].toLowerCase();
31
+ // switch (unit) {
32
+ // case 'mb': return nr * 1e6;
33
+ // case 'kb': return nr * 1e3;
34
+ // case 'b': return nr;
35
+ // }
36
+ // }, env.config.maxPayloadSize);
37
+ const maxPayloadBytes = 10e7; // Socket is closed if sent message exceeds this. Socket.io 2.x default is 10e7 (100MB)
38
+
39
+ const server = createSocketIOServer(env.server, {
40
+ // See https://socket.io/docs/v2/server-initialization/ and https://socket.io/docs/v3/server-initialization/
41
+ pingInterval: 5000, // socket.io 2.x default is 25000
42
+ pingTimeout: 5000, // socket.io 2.x default is 5000, 3.x default = 20000
43
+ maxHttpBufferSize: maxPayloadBytes,
44
+
45
+ // socket.io 2.x:
46
+ handlePreflightRequest: (req, res) => {
47
+ const headers = getCorsHeaders(env.config.allowOrigin, req.headers.origin);
48
+ res.writeHead(200, headers);
49
+ res.end();
50
+ }
51
+
52
+ // socket.io 3+ uses cors package:
53
+ // cors: getCorsOptions(env.config.allowOrigin)
54
+ });
55
+
56
+ // Setup event emitter for communication with consuming server
57
+ const manager = new SocketIOManager();
58
+
59
+ server.sockets.on('connection', socket => {
60
+
61
+ const { protocol, host, port } = (socket.request as IncomingMessage).headers;
62
+
63
+ // Notify manager of new connection
64
+ manager.emit('connect', { socket, socket_id: socket.id });
65
+
66
+ // Pass any events to manager
67
+ socket.on('disconnect', data => manager.emit('disconnect', { socket, socket_id: socket.id, data }));
68
+ socket.on('reconnect', data => manager.emit('connect', { socket, socket_id: socket.id, data }));
69
+ socket.on('signin', accessToken => manager.emit('signin', { socket, socket_id: socket.id, data: { accessToken } }));
70
+ socket.on('signout', data => manager.emit('signout', { socket, socket_id: socket.id, data }));
71
+ socket.on('oauth2-signin', data => {
72
+ data.server = { protocol, host, port }; // Add server info - event handler needs that to contruct callback url for OAuth2 provider
73
+ manager.emit('oauth2-signin', { socket, socket_id: socket.id, data });
74
+ });
75
+ socket.on('subscribe', data => manager.emit('subscribe', { socket, socket_id: socket.id, data }));
76
+ socket.on('unsubscribe', data => manager.emit('unsubscribe', { socket, socket_id: socket.id, data }));
77
+ socket.on('query-unsubscribe', data => manager.emit('query-unsubscribe', { socket, socket_id: socket.id, data }));
78
+ socket.on('query_unsubscribe', data => manager.emit('query-unsubscribe', { socket, socket_id: socket.id, data })); // OLD spelling "query_unsubscribe"
79
+ socket.on('transaction', data => {
80
+ if (data.action === 'start') {
81
+ manager.emit('transaction-start', { socket, socket_id: socket.id, data });
82
+ }
83
+ else if (data.action === 'finish') {
84
+ manager.emit('transaction-finish', { socket, socket_id: socket.id, data });
85
+ }
86
+ });
87
+
88
+ });
89
+
90
+ return manager;
91
+ }
@@ -0,0 +1,10 @@
1
+ {
2
+ "extends": "./tsconfig.json",
3
+ "compilerOptions": {
4
+ "target": "es2015",
5
+ "module": "commonjs",
6
+ "outDir": "./dist/cjs",
7
+ "declaration": false,
8
+ "declarationDir": null
9
+ }
10
+ }