acebase-server 1.8.0 → 1.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (509) hide show
  1. package/.vscode/launch.json +24 -0
  2. package/create-package-files +12 -0
  3. package/dist/cjs/auth.js +89 -0
  4. package/dist/cjs/auth.js.map +1 -0
  5. package/dist/cjs/cluster.js +57 -0
  6. package/dist/cjs/cluster.js.map +1 -0
  7. package/dist/cjs/index.js +9 -0
  8. package/dist/cjs/index.js.map +1 -0
  9. package/dist/cjs/middleware/404.js +15 -0
  10. package/dist/cjs/middleware/404.js.map +1 -0
  11. package/dist/cjs/middleware/cache.js +15 -0
  12. package/dist/cjs/middleware/cache.js.map +1 -0
  13. package/dist/cjs/middleware/connection.js +50 -0
  14. package/dist/cjs/middleware/connection.js.map +1 -0
  15. package/dist/cjs/middleware/context.js +21 -0
  16. package/dist/cjs/middleware/context.js.map +1 -0
  17. package/dist/cjs/middleware/cors.js +51 -0
  18. package/dist/cjs/middleware/cors.js.map +1 -0
  19. package/dist/cjs/middleware/swagger.js +18 -0
  20. package/dist/cjs/middleware/swagger.js.map +1 -0
  21. package/dist/cjs/middleware/user.js +58 -0
  22. package/dist/cjs/middleware/user.js.map +1 -0
  23. package/dist/cjs/oauth-providers/dropbox.js +109 -0
  24. package/dist/cjs/oauth-providers/dropbox.js.map +1 -0
  25. package/dist/cjs/oauth-providers/facebook.js +85 -0
  26. package/dist/cjs/oauth-providers/facebook.js.map +1 -0
  27. package/dist/cjs/oauth-providers/google.js +125 -0
  28. package/dist/cjs/oauth-providers/google.js.map +1 -0
  29. package/dist/cjs/oauth-providers/index.js +27 -0
  30. package/dist/cjs/oauth-providers/index.js.map +1 -0
  31. package/dist/cjs/oauth-providers/instagram.js +80 -0
  32. package/dist/cjs/oauth-providers/instagram.js.map +1 -0
  33. package/dist/cjs/oauth-providers/oauth-provider.js +3 -0
  34. package/dist/cjs/oauth-providers/oauth-provider.js.map +1 -0
  35. package/dist/cjs/oauth-providers/spotify.js +113 -0
  36. package/dist/cjs/oauth-providers/spotify.js.map +1 -0
  37. package/dist/cjs/package.json +3 -0
  38. package/dist/cjs/routes/auth-change-password.js +85 -0
  39. package/dist/cjs/routes/auth-change-password.js.map +1 -0
  40. package/dist/cjs/routes/auth-delete.js +51 -0
  41. package/dist/cjs/routes/auth-delete.js.map +1 -0
  42. package/dist/cjs/routes/auth-forgot-password.js +75 -0
  43. package/dist/cjs/routes/auth-forgot-password.js.map +1 -0
  44. package/dist/cjs/routes/auth-reset-password.js +94 -0
  45. package/dist/cjs/routes/auth-reset-password.js.map +1 -0
  46. package/dist/cjs/routes/auth-signin.js +47 -0
  47. package/dist/cjs/routes/auth-signin.js.map +1 -0
  48. package/dist/cjs/routes/auth-signout.js +60 -0
  49. package/dist/cjs/routes/auth-signout.js.map +1 -0
  50. package/dist/cjs/routes/auth-signup.js +141 -0
  51. package/dist/cjs/routes/auth-signup.js.map +1 -0
  52. package/dist/cjs/routes/auth-state.js +26 -0
  53. package/dist/cjs/routes/auth-state.js.map +1 -0
  54. package/dist/cjs/routes/auth-update.js +129 -0
  55. package/dist/cjs/routes/auth-update.js.map +1 -0
  56. package/dist/cjs/routes/auth-verify-email.js +67 -0
  57. package/dist/cjs/routes/auth-verify-email.js.map +1 -0
  58. package/dist/cjs/routes/auth.js +55 -0
  59. package/dist/cjs/routes/auth.js.map +1 -0
  60. package/dist/cjs/routes/data-exists.js +34 -0
  61. package/dist/cjs/routes/data-exists.js.map +1 -0
  62. package/dist/cjs/routes/data-export.js +49 -0
  63. package/dist/cjs/routes/data-export.js.map +1 -0
  64. package/dist/cjs/routes/data-get.js +67 -0
  65. package/dist/cjs/routes/data-get.js.map +1 -0
  66. package/dist/cjs/routes/data-import.js +55 -0
  67. package/dist/cjs/routes/data-import.js.map +1 -0
  68. package/dist/cjs/routes/data-index-create.js +45 -0
  69. package/dist/cjs/routes/data-index-create.js.map +1 -0
  70. package/dist/cjs/routes/data-index-delete.js +36 -0
  71. package/dist/cjs/routes/data-index-delete.js.map +1 -0
  72. package/dist/cjs/routes/data-index-list.js +35 -0
  73. package/dist/cjs/routes/data-index-list.js.map +1 -0
  74. package/dist/cjs/routes/data-query.js +71 -0
  75. package/dist/cjs/routes/data-query.js.map +1 -0
  76. package/dist/cjs/routes/data-reflect.js +89 -0
  77. package/dist/cjs/routes/data-reflect.js.map +1 -0
  78. package/dist/cjs/routes/data-schema-get.js +39 -0
  79. package/dist/cjs/routes/data-schema-get.js.map +1 -0
  80. package/dist/cjs/routes/data-schema-set.js +33 -0
  81. package/dist/cjs/routes/data-schema-set.js.map +1 -0
  82. package/dist/cjs/routes/data-schema-test.js +46 -0
  83. package/dist/cjs/routes/data-schema-test.js.map +1 -0
  84. package/dist/cjs/routes/data-schemas-list.js +35 -0
  85. package/dist/cjs/routes/data-schemas-list.js.map +1 -0
  86. package/dist/cjs/routes/data-set.js +72 -0
  87. package/dist/cjs/routes/data-set.js.map +1 -0
  88. package/dist/cjs/routes/data-sync-changes.js +68 -0
  89. package/dist/cjs/routes/data-sync-changes.js.map +1 -0
  90. package/dist/cjs/routes/data-sync-mutations.js +68 -0
  91. package/dist/cjs/routes/data-sync-mutations.js.map +1 -0
  92. package/dist/cjs/routes/data-transaction.js +120 -0
  93. package/dist/cjs/routes/data-transaction.js.map +1 -0
  94. package/dist/cjs/routes/data-update.js +71 -0
  95. package/dist/cjs/routes/data-update.js.map +1 -0
  96. package/dist/cjs/routes/data.js +63 -0
  97. package/dist/cjs/routes/data.js.map +1 -0
  98. package/dist/cjs/routes/docs.js +249 -0
  99. package/dist/cjs/routes/docs.js.map +1 -0
  100. package/dist/cjs/routes/meta-info.js +70 -0
  101. package/dist/cjs/routes/meta-info.js.map +1 -0
  102. package/dist/cjs/routes/meta-ping.js +12 -0
  103. package/dist/cjs/routes/meta-ping.js.map +1 -0
  104. package/dist/cjs/routes/meta-stats.js +28 -0
  105. package/dist/cjs/routes/meta-stats.js.map +1 -0
  106. package/dist/cjs/routes/meta.js +17 -0
  107. package/dist/cjs/routes/meta.js.map +1 -0
  108. package/dist/cjs/routes/oauth2-init.js +52 -0
  109. package/dist/cjs/routes/oauth2-init.js.map +1 -0
  110. package/dist/cjs/routes/oauth2-refresh.js +43 -0
  111. package/dist/cjs/routes/oauth2-refresh.js.map +1 -0
  112. package/dist/cjs/routes/oauth2-signin.js +262 -0
  113. package/dist/cjs/routes/oauth2-signin.js.map +1 -0
  114. package/dist/cjs/routes/webmanager.js +27 -0
  115. package/dist/cjs/routes/webmanager.js.map +1 -0
  116. package/dist/cjs/rules.js +175 -0
  117. package/dist/cjs/rules.js.map +1 -0
  118. package/dist/cjs/schema/user.js +26 -0
  119. package/dist/cjs/schema/user.js.map +1 -0
  120. package/dist/cjs/server.js +363 -0
  121. package/dist/cjs/server.js.map +1 -0
  122. package/dist/cjs/settings/email.js +5 -0
  123. package/dist/cjs/settings/email.js.map +1 -0
  124. package/dist/cjs/settings/index.js +159 -0
  125. package/dist/cjs/settings/index.js.map +1 -0
  126. package/dist/cjs/shared/clients.js +27 -0
  127. package/dist/cjs/shared/clients.js.map +1 -0
  128. package/dist/cjs/shared/email.js +7 -0
  129. package/dist/cjs/shared/email.js.map +1 -0
  130. package/{src/oauth-providers/oauth-provider.js → dist/cjs/shared/env.js} +3 -0
  131. package/dist/cjs/shared/env.js.map +1 -0
  132. package/dist/cjs/shared/error.js +35 -0
  133. package/dist/cjs/shared/error.js.map +1 -0
  134. package/dist/cjs/shared/http.js +21 -0
  135. package/dist/cjs/shared/http.js.map +1 -0
  136. package/dist/cjs/shared/password.js +46 -0
  137. package/dist/cjs/shared/password.js.map +1 -0
  138. package/dist/cjs/shared/rootpath.js +15 -0
  139. package/dist/cjs/shared/rootpath.js.map +1 -0
  140. package/dist/cjs/shared/signin.js +139 -0
  141. package/dist/cjs/shared/signin.js.map +1 -0
  142. package/dist/cjs/shared/simple-fetch.js +77 -0
  143. package/dist/cjs/shared/simple-fetch.js.map +1 -0
  144. package/dist/cjs/shared/tokens.js +79 -0
  145. package/dist/cjs/shared/tokens.js.map +1 -0
  146. package/dist/cjs/shared/validate.js +62 -0
  147. package/dist/cjs/shared/validate.js.map +1 -0
  148. package/dist/cjs/start.js +51 -0
  149. package/dist/cjs/start.js.map +1 -0
  150. package/dist/cjs/test.js +11 -0
  151. package/dist/cjs/test.js.map +1 -0
  152. package/dist/cjs/websocket/index.js +301 -0
  153. package/dist/cjs/websocket/index.js.map +1 -0
  154. package/dist/cjs/websocket/manager.js +16 -0
  155. package/dist/cjs/websocket/manager.js.map +1 -0
  156. package/dist/cjs/websocket/socket.io.js +79 -0
  157. package/dist/cjs/websocket/socket.io.js.map +1 -0
  158. package/dist/esm/auth.js +76 -0
  159. package/dist/esm/auth.js.map +1 -0
  160. package/{src → dist/esm}/cluster.js +9 -14
  161. package/dist/esm/cluster.js.map +1 -0
  162. package/dist/esm/index.js +3 -0
  163. package/dist/esm/index.js.map +1 -0
  164. package/dist/esm/middleware/404.js +11 -0
  165. package/dist/esm/middleware/404.js.map +1 -0
  166. package/dist/esm/middleware/cache.js +11 -0
  167. package/dist/esm/middleware/cache.js.map +1 -0
  168. package/dist/esm/middleware/connection.js +46 -0
  169. package/dist/esm/middleware/connection.js.map +1 -0
  170. package/dist/esm/middleware/context.js +17 -0
  171. package/dist/esm/middleware/context.js.map +1 -0
  172. package/dist/esm/middleware/cors.js +45 -0
  173. package/dist/esm/middleware/cors.js.map +1 -0
  174. package/dist/esm/middleware/swagger.js +14 -0
  175. package/dist/esm/middleware/swagger.js.map +1 -0
  176. package/dist/esm/middleware/user.js +45 -0
  177. package/dist/esm/middleware/user.js.map +1 -0
  178. package/{src → dist/esm}/oauth-providers/dropbox.js +11 -9
  179. package/dist/esm/oauth-providers/dropbox.js.map +1 -0
  180. package/{src → dist/esm}/oauth-providers/facebook.js +6 -9
  181. package/dist/esm/oauth-providers/facebook.js.map +1 -0
  182. package/{src → dist/esm}/oauth-providers/google.js +8 -11
  183. package/dist/esm/oauth-providers/google.js.map +1 -0
  184. package/dist/esm/oauth-providers/index.js +19 -0
  185. package/dist/esm/oauth-providers/index.js.map +1 -0
  186. package/{src → dist/esm}/oauth-providers/instagram.js +6 -9
  187. package/dist/esm/oauth-providers/instagram.js.map +1 -0
  188. package/dist/esm/oauth-providers/oauth-provider.js +2 -0
  189. package/dist/esm/oauth-providers/oauth-provider.js.map +1 -0
  190. package/{src → dist/esm}/oauth-providers/spotify.js +7 -10
  191. package/dist/esm/oauth-providers/spotify.js.map +1 -0
  192. package/dist/esm/package.json +3 -0
  193. package/dist/esm/routes/auth-change-password.js +70 -0
  194. package/dist/esm/routes/auth-change-password.js.map +1 -0
  195. package/dist/esm/routes/auth-delete.js +36 -0
  196. package/dist/esm/routes/auth-delete.js.map +1 -0
  197. package/dist/esm/routes/auth-forgot-password.js +61 -0
  198. package/dist/esm/routes/auth-forgot-password.js.map +1 -0
  199. package/dist/esm/routes/auth-reset-password.js +78 -0
  200. package/dist/esm/routes/auth-reset-password.js.map +1 -0
  201. package/dist/esm/routes/auth-signin.js +34 -0
  202. package/dist/esm/routes/auth-signin.js.map +1 -0
  203. package/dist/esm/routes/auth-signout.js +46 -0
  204. package/dist/esm/routes/auth-signout.js.map +1 -0
  205. package/dist/esm/routes/auth-signup.js +126 -0
  206. package/dist/esm/routes/auth-signup.js.map +1 -0
  207. package/dist/esm/routes/auth-state.js +13 -0
  208. package/dist/esm/routes/auth-state.js.map +1 -0
  209. package/dist/esm/routes/auth-update.js +115 -0
  210. package/dist/esm/routes/auth-update.js.map +1 -0
  211. package/dist/esm/routes/auth-verify-email.js +52 -0
  212. package/dist/esm/routes/auth-verify-email.js.map +1 -0
  213. package/dist/esm/routes/auth.js +51 -0
  214. package/dist/esm/routes/auth.js.map +1 -0
  215. package/dist/esm/routes/data-exists.js +21 -0
  216. package/dist/esm/routes/data-exists.js.map +1 -0
  217. package/dist/esm/routes/data-export.js +36 -0
  218. package/dist/esm/routes/data-export.js.map +1 -0
  219. package/dist/esm/routes/data-get.js +53 -0
  220. package/dist/esm/routes/data-get.js.map +1 -0
  221. package/dist/esm/routes/data-import.js +42 -0
  222. package/dist/esm/routes/data-import.js.map +1 -0
  223. package/dist/esm/routes/data-index-create.js +31 -0
  224. package/dist/esm/routes/data-index-create.js.map +1 -0
  225. package/dist/esm/routes/data-index-delete.js +23 -0
  226. package/dist/esm/routes/data-index-delete.js.map +1 -0
  227. package/dist/esm/routes/data-index-list.js +22 -0
  228. package/dist/esm/routes/data-index-list.js.map +1 -0
  229. package/dist/esm/routes/data-query.js +57 -0
  230. package/dist/esm/routes/data-query.js.map +1 -0
  231. package/dist/esm/routes/data-reflect.js +76 -0
  232. package/dist/esm/routes/data-reflect.js.map +1 -0
  233. package/dist/esm/routes/data-schema-get.js +26 -0
  234. package/dist/esm/routes/data-schema-get.js.map +1 -0
  235. package/dist/esm/routes/data-schema-set.js +20 -0
  236. package/dist/esm/routes/data-schema-set.js.map +1 -0
  237. package/dist/esm/routes/data-schema-test.js +32 -0
  238. package/dist/esm/routes/data-schema-test.js.map +1 -0
  239. package/dist/esm/routes/data-schemas-list.js +22 -0
  240. package/dist/esm/routes/data-schemas-list.js.map +1 -0
  241. package/dist/esm/routes/data-set.js +57 -0
  242. package/dist/esm/routes/data-set.js.map +1 -0
  243. package/dist/esm/routes/data-sync-changes.js +54 -0
  244. package/dist/esm/routes/data-sync-changes.js.map +1 -0
  245. package/dist/esm/routes/data-sync-mutations.js +54 -0
  246. package/dist/esm/routes/data-sync-mutations.js.map +1 -0
  247. package/dist/esm/routes/data-transaction.js +104 -0
  248. package/dist/esm/routes/data-transaction.js.map +1 -0
  249. package/dist/esm/routes/data-update.js +56 -0
  250. package/dist/esm/routes/data-update.js.map +1 -0
  251. package/dist/esm/routes/data.js +59 -0
  252. package/dist/esm/routes/data.js.map +1 -0
  253. package/dist/esm/routes/docs.js +244 -0
  254. package/dist/esm/routes/docs.js.map +1 -0
  255. package/dist/esm/routes/meta-info.js +66 -0
  256. package/dist/esm/routes/meta-info.js.map +1 -0
  257. package/dist/esm/routes/meta-ping.js +8 -0
  258. package/dist/esm/routes/meta-ping.js.map +1 -0
  259. package/dist/esm/routes/meta-stats.js +15 -0
  260. package/dist/esm/routes/meta-stats.js.map +1 -0
  261. package/dist/esm/routes/meta.js +13 -0
  262. package/dist/esm/routes/meta.js.map +1 -0
  263. package/dist/esm/routes/oauth2-init.js +39 -0
  264. package/dist/esm/routes/oauth2-init.js.map +1 -0
  265. package/dist/esm/routes/oauth2-refresh.js +30 -0
  266. package/dist/esm/routes/oauth2-refresh.js.map +1 -0
  267. package/dist/esm/routes/oauth2-signin.js +248 -0
  268. package/dist/esm/routes/oauth2-signin.js.map +1 -0
  269. package/dist/esm/routes/webmanager.js +23 -0
  270. package/dist/esm/routes/webmanager.js.map +1 -0
  271. package/dist/esm/rules.js +171 -0
  272. package/dist/esm/rules.js.map +1 -0
  273. package/dist/esm/schema/user.js +21 -0
  274. package/dist/esm/schema/user.js.map +1 -0
  275. package/dist/esm/server.js +344 -0
  276. package/dist/esm/server.js.map +1 -0
  277. package/dist/esm/settings/email.js +4 -0
  278. package/dist/esm/settings/email.js.map +1 -0
  279. package/dist/esm/settings/index.js +152 -0
  280. package/dist/esm/settings/index.js.map +1 -0
  281. package/dist/esm/shared/clients.js +23 -0
  282. package/dist/esm/shared/clients.js.map +1 -0
  283. package/dist/esm/shared/email.js +6 -0
  284. package/dist/esm/shared/email.js.map +1 -0
  285. package/dist/esm/shared/env.js +4 -0
  286. package/dist/esm/shared/env.js.map +1 -0
  287. package/dist/esm/shared/error.js +27 -0
  288. package/dist/esm/shared/error.js.map +1 -0
  289. package/dist/esm/shared/http.js +16 -0
  290. package/dist/esm/shared/http.js.map +1 -0
  291. package/dist/esm/shared/password.js +39 -0
  292. package/dist/esm/shared/password.js.map +1 -0
  293. package/dist/esm/shared/rootpath.js +12 -0
  294. package/dist/esm/shared/rootpath.js.map +1 -0
  295. package/dist/esm/shared/signin.js +125 -0
  296. package/dist/esm/shared/signin.js.map +1 -0
  297. package/{src/oauth-providers → dist/esm/shared}/simple-fetch.js +7 -10
  298. package/dist/esm/shared/simple-fetch.js.map +1 -0
  299. package/dist/esm/shared/tokens.js +72 -0
  300. package/dist/esm/shared/tokens.js.map +1 -0
  301. package/dist/esm/shared/validate.js +42 -0
  302. package/dist/esm/shared/validate.js.map +1 -0
  303. package/dist/esm/start.js +48 -0
  304. package/dist/esm/start.js.map +1 -0
  305. package/dist/esm/test.js +9 -0
  306. package/dist/esm/test.js.map +1 -0
  307. package/dist/esm/websocket/index.js +288 -0
  308. package/dist/esm/websocket/index.js.map +1 -0
  309. package/dist/esm/websocket/manager.js +12 -0
  310. package/dist/esm/websocket/manager.js.map +1 -0
  311. package/dist/esm/websocket/socket.io.js +73 -0
  312. package/dist/esm/websocket/socket.io.js.map +1 -0
  313. package/dist/types/auth.d.ts +3 -0
  314. package/dist/types/cluster.d.ts +1 -0
  315. package/dist/types/index.d.ts +2 -0
  316. package/dist/types/middleware/404.d.ts +7 -0
  317. package/dist/types/middleware/cache.d.ts +3 -0
  318. package/dist/types/middleware/connection.d.ts +7 -0
  319. package/dist/types/middleware/context.d.ts +3 -0
  320. package/dist/types/middleware/cors.d.ts +25 -0
  321. package/dist/types/middleware/swagger.d.ts +3 -0
  322. package/dist/types/middleware/user.d.ts +2 -0
  323. package/dist/types/oauth-providers/dropbox.d.ts +63 -0
  324. package/dist/types/oauth-providers/facebook.d.ts +45 -0
  325. package/dist/types/oauth-providers/google.d.ts +47 -0
  326. package/dist/types/oauth-providers/index.d.ts +18 -0
  327. package/dist/types/oauth-providers/instagram.d.ts +54 -0
  328. package/dist/types/oauth-providers/oauth-provider.d.ts +70 -0
  329. package/dist/types/oauth-providers/spotify.d.ts +57 -0
  330. package/dist/types/routes/auth-change-password.d.ts +20 -0
  331. package/dist/types/routes/auth-delete.d.ts +16 -0
  332. package/dist/types/routes/auth-forgot-password.d.ts +16 -0
  333. package/dist/types/routes/auth-reset-password.d.ts +23 -0
  334. package/dist/types/routes/auth-signin.d.ts +24 -0
  335. package/dist/types/routes/auth-signout.d.ts +14 -0
  336. package/dist/types/routes/auth-signup.d.ts +32 -0
  337. package/dist/types/routes/auth-state.d.ts +13 -0
  338. package/dist/types/routes/auth-update.d.ts +33 -0
  339. package/dist/types/routes/auth-verify-email.d.ts +21 -0
  340. package/dist/types/routes/auth.d.ts +6 -0
  341. package/dist/types/routes/data-exists.d.ts +9 -0
  342. package/dist/types/routes/data-export.d.ts +10 -0
  343. package/dist/types/routes/data-get.d.ts +14 -0
  344. package/dist/types/routes/data-import.d.ts +13 -0
  345. package/dist/types/routes/data-index-create.d.ts +51 -0
  346. package/dist/types/routes/data-index-delete.d.ts +17 -0
  347. package/dist/types/routes/data-index-list.d.ts +21 -0
  348. package/dist/types/routes/data-query.d.ts +49 -0
  349. package/dist/types/routes/data-reflect.d.ts +29 -0
  350. package/dist/types/routes/data-schema-get.d.ts +11 -0
  351. package/dist/types/routes/data-schema-set.d.ts +19 -0
  352. package/dist/types/routes/data-schema-test.d.ts +21 -0
  353. package/dist/types/routes/data-schemas-list.d.ts +11 -0
  354. package/dist/types/routes/data-set.d.ts +27 -0
  355. package/dist/types/routes/data-sync-changes.d.ts +28 -0
  356. package/dist/types/routes/data-sync-mutations.d.ts +28 -0
  357. package/dist/types/routes/data-transaction.d.ts +34 -0
  358. package/dist/types/routes/data-update.d.ts +27 -0
  359. package/dist/types/routes/data.d.ts +3 -0
  360. package/dist/types/routes/docs.d.ts +3 -0
  361. package/dist/types/routes/meta-info.d.ts +11 -0
  362. package/dist/types/routes/meta-ping.d.ts +7 -0
  363. package/dist/types/routes/meta-stats.d.ts +13 -0
  364. package/dist/types/routes/meta.d.ts +3 -0
  365. package/dist/types/routes/oauth2-init.d.ts +13 -0
  366. package/dist/types/routes/oauth2-refresh.d.ts +17 -0
  367. package/dist/types/routes/oauth2-signin.d.ts +15 -0
  368. package/dist/types/routes/webmanager.d.ts +3 -0
  369. package/dist/types/rules.d.ts +41 -0
  370. package/dist/types/schema/user.d.ts +85 -0
  371. package/dist/types/server.d.ts +106 -0
  372. package/dist/types/settings/email.d.ts +14 -0
  373. package/dist/types/settings/index.d.ts +165 -0
  374. package/dist/types/shared/clients.d.ts +44 -0
  375. package/dist/types/shared/email.d.ts +34 -0
  376. package/dist/types/shared/env.d.ts +42 -0
  377. package/dist/types/shared/error.d.ts +15 -0
  378. package/dist/types/shared/http.d.ts +14 -0
  379. package/dist/types/shared/password.d.ts +19 -0
  380. package/dist/types/shared/rootpath.d.ts +2 -0
  381. package/dist/types/shared/signin.d.ts +31 -0
  382. package/dist/types/shared/simple-fetch.d.ts +21 -0
  383. package/dist/types/shared/tokens.d.ts +23 -0
  384. package/dist/types/shared/validate.d.ts +22 -0
  385. package/dist/types/start.d.ts +1 -0
  386. package/dist/types/test.d.ts +1 -0
  387. package/dist/types/websocket/index.d.ts +2 -0
  388. package/dist/types/websocket/manager.d.ts +99 -0
  389. package/dist/types/websocket/socket.io.d.ts +10 -0
  390. package/package.json +25 -8
  391. package/src/auth.ts +87 -0
  392. package/src/cluster.ts +62 -0
  393. package/src/index.ts +2 -0
  394. package/src/middleware/404.ts +13 -0
  395. package/src/middleware/cache.ts +15 -0
  396. package/src/middleware/connection.ts +48 -0
  397. package/src/middleware/context.ts +23 -0
  398. package/src/middleware/cors.ts +49 -0
  399. package/src/middleware/swagger.ts +19 -0
  400. package/src/middleware/user.ts +51 -0
  401. package/src/{ts/oauth-providers → oauth-providers}/dropbox.ts +1 -1
  402. package/src/{ts/oauth-providers → oauth-providers}/facebook.ts +1 -1
  403. package/src/{ts/oauth-providers → oauth-providers}/google.ts +1 -1
  404. package/src/oauth-providers/index.ts +20 -0
  405. package/src/{ts/oauth-providers → oauth-providers}/instagram.ts +1 -1
  406. package/src/{ts/oauth-providers → oauth-providers}/oauth-provider.ts +0 -0
  407. package/src/{ts/oauth-providers → oauth-providers}/spotify.ts +1 -1
  408. package/src/routes/auth-change-password.ts +89 -0
  409. package/src/routes/auth-change-password.yaml +74 -0
  410. package/src/routes/auth-delete.ts +47 -0
  411. package/src/routes/auth-delete.yaml +78 -0
  412. package/src/routes/auth-forgot-password.ts +73 -0
  413. package/src/routes/auth-forgot-password.yaml +50 -0
  414. package/src/routes/auth-reset-password.ts +93 -0
  415. package/src/routes/auth-reset-password.yaml +54 -0
  416. package/src/routes/auth-signin.ts +55 -0
  417. package/src/routes/auth-signin.yaml +130 -0
  418. package/src/routes/auth-signout.ts +61 -0
  419. package/src/routes/auth-signout.yaml +46 -0
  420. package/src/routes/auth-signup.ts +161 -0
  421. package/src/routes/auth-signup.yaml +136 -0
  422. package/src/routes/auth-state.ts +20 -0
  423. package/src/routes/auth-state.yaml +29 -0
  424. package/src/routes/auth-update.ts +147 -0
  425. package/src/routes/auth-update.yaml +152 -0
  426. package/src/routes/auth-verify-email.ts +67 -0
  427. package/src/routes/auth-verify-email.yaml +53 -0
  428. package/src/routes/auth.ts +67 -0
  429. package/src/routes/data-exists.ts +31 -0
  430. package/src/routes/data-exists.yaml +44 -0
  431. package/src/routes/data-export.ts +51 -0
  432. package/src/routes/data-export.yaml +64 -0
  433. package/src/routes/data-get.ts +68 -0
  434. package/src/routes/data-get.yaml +54 -0
  435. package/src/routes/data-import.ts +56 -0
  436. package/src/routes/data-import.yaml +75 -0
  437. package/src/routes/data-index-create.ts +85 -0
  438. package/src/routes/data-index-create.yaml +105 -0
  439. package/src/routes/data-index-delete.ts +39 -0
  440. package/src/routes/data-index-delete.yaml +51 -0
  441. package/src/routes/data-index-list.ts +42 -0
  442. package/src/routes/data-index-list.yaml +80 -0
  443. package/src/routes/data-query.ts +97 -0
  444. package/src/routes/data-query.yaml +166 -0
  445. package/src/routes/data-reflect.ts +94 -0
  446. package/src/routes/data-reflect.yaml +124 -0
  447. package/src/routes/data-schema-get.ts +38 -0
  448. package/src/routes/data-schema-get.yaml +53 -0
  449. package/src/routes/data-schema-set.ts +38 -0
  450. package/src/routes/data-schema-set.yaml +60 -0
  451. package/src/routes/data-schema-test.ts +53 -0
  452. package/src/routes/data-schema-test.yaml +66 -0
  453. package/src/routes/data-schemas-list.ts +33 -0
  454. package/src/routes/data-schemas-list.yaml +41 -0
  455. package/src/routes/data-set.ts +76 -0
  456. package/src/routes/data-set.yaml +71 -0
  457. package/src/routes/data-sync-changes.ts +78 -0
  458. package/src/routes/data-sync-changes.yaml +67 -0
  459. package/src/routes/data-sync-mutations.ts +78 -0
  460. package/src/routes/data-sync-mutations.yaml +67 -0
  461. package/src/routes/data-transaction-finish.yaml +76 -0
  462. package/src/routes/data-transaction-start.yaml +58 -0
  463. package/src/routes/data-transaction.ts +144 -0
  464. package/src/routes/data-update.ts +77 -0
  465. package/src/routes/data-update.yaml +71 -0
  466. package/src/routes/data.ts +79 -0
  467. package/src/routes/docs.ts +249 -0
  468. package/src/routes/meta-info.ts +80 -0
  469. package/src/routes/meta-info.yaml +41 -0
  470. package/src/routes/meta-ping.ts +15 -0
  471. package/src/routes/meta-ping.yaml +23 -0
  472. package/src/routes/meta-stats.ts +31 -0
  473. package/src/routes/meta-stats.yaml +41 -0
  474. package/src/routes/meta.ts +18 -0
  475. package/src/routes/oauth2-init.ts +44 -0
  476. package/src/routes/oauth2-init.yaml +63 -0
  477. package/src/routes/oauth2-refresh.ts +39 -0
  478. package/src/routes/oauth2-refresh.yaml +65 -0
  479. package/src/routes/oauth2-signin.ts +281 -0
  480. package/src/routes/oauth2-signin.yaml +66 -0
  481. package/src/routes/webmanager.ts +29 -0
  482. package/src/rules.ts +196 -0
  483. package/src/schema/user.ts +99 -0
  484. package/src/server.ts +416 -0
  485. package/src/settings/email.ts +18 -0
  486. package/src/settings/index.ts +241 -0
  487. package/src/shared/clients.ts +31 -0
  488. package/src/shared/email.ts +33 -0
  489. package/src/shared/env.ts +38 -0
  490. package/src/shared/error.ts +37 -0
  491. package/src/shared/http.ts +24 -0
  492. package/src/shared/password.ts +41 -0
  493. package/src/shared/rootpath.ts +15 -0
  494. package/src/shared/signin.ts +143 -0
  495. package/src/{ts/oauth-providers → shared}/simple-fetch.ts +2 -2
  496. package/src/shared/tokens.ts +77 -0
  497. package/src/shared/validate.ts +53 -0
  498. package/src/{start.js → start.ts} +7 -5
  499. package/src/test.ts +10 -0
  500. package/src/websocket/index.ts +320 -0
  501. package/src/websocket/manager.ts +46 -0
  502. package/src/websocket/socket.io.ts +91 -0
  503. package/tsconfig-cjs.json +10 -0
  504. package/tsconfig.json +13 -5
  505. package/{src/webmanager → webmanager}/index.html +0 -0
  506. package/{src/webmanager → webmanager}/index.js +0 -0
  507. package/src/acebase-server.js +0 -3053
  508. package/src/index.d.ts +0 -212
  509. package/src/index.js +0 -2
@@ -0,0 +1,67 @@
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+ import { DbUserAccountDetails } from '../schema/user';
3
+ import { parseSignedPublicToken } from '../shared/tokens';
4
+ import { sendBadRequestError, sendUnexpectedError } from '../shared/error';
5
+
6
+ export class VerifyEmailError extends Error {
7
+ constructor(public code: 'invalid_code'|'unknown_user', message: string) {
8
+ super(message);
9
+ }
10
+ }
11
+
12
+ export type RequestQuery = {};
13
+ export type RequestBody = { code: string };
14
+ export type ResponseBody = 'OK' | { code: string; message: string };
15
+ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
16
+
17
+ /**
18
+ * Adds the verify_email route and returns the verification function that can be used to manually verify an email address
19
+ * @param env environment
20
+ * @returns returns the verification function
21
+ */
22
+ export const addRoute = (env: RouteInitEnvironment) => {
23
+
24
+ const verifyEmailAddress = async (clientIp: string, code: string) => {
25
+ try {
26
+ var verification = parseSignedPublicToken(code, env.tokenSalt);
27
+ }
28
+ catch (err) {
29
+ throw new VerifyEmailError('invalid_code', err.message);
30
+ }
31
+
32
+ const snap = await env.authRef.child(verification.uid).get();
33
+ if (!snap.exists()) {
34
+ throw new VerifyEmailError('unknown_user', 'Unknown user');
35
+ }
36
+ const user: DbUserAccountDetails = snap.val();
37
+ user.uid = snap.key as string;
38
+
39
+ // No need to do further checks, code was signed by us so we can trust the contents
40
+ // Mark account as verified
41
+ await snap.ref.update({ email_verified: true });
42
+
43
+ env.logRef.push({ action: 'verify_email', success: true, ip: clientIp, date: new Date(), uid: user.uid });
44
+ };
45
+
46
+ env.app.post(`/auth/${env.db.name}/verify_email`, async (req: Request, res) => {
47
+
48
+ const details = req.body;
49
+ try {
50
+ await verifyEmailAddress(req.ip, details.code);
51
+ res.send('OK');
52
+ }
53
+ catch (err) {
54
+ env.logRef.push({ action: 'verify_email', success: false, code: err.code, message: err.message, ip: req.ip, date: new Date(), uid: req.user?.uid ?? null });
55
+ if (err.code) {
56
+ sendBadRequestError(res, err);
57
+ }
58
+ else {
59
+ sendUnexpectedError(res, err);
60
+ }
61
+ }
62
+ });
63
+
64
+ return verifyEmailAddress;
65
+ };
66
+
67
+ export default addRoute;
@@ -0,0 +1,53 @@
1
+ /auth/{dbname}/verify_email:
2
+ post:
3
+ tags:
4
+ - auth
5
+ summary: Verifies an email address
6
+ description: Verifies an email address with a code sent through their email address
7
+ parameters:
8
+ - name: dbname
9
+ in: path
10
+ description: name of the database
11
+ required: true
12
+ schema:
13
+ type: string
14
+ example: mydb
15
+ requestBody:
16
+ description: verification object
17
+ content:
18
+ 'application/json':
19
+ schema:
20
+ type: object
21
+ properties:
22
+ code:
23
+ type: string
24
+ description: Verification code that was sent to the user's email address
25
+ required:
26
+ - code
27
+ example:
28
+ code: ewrg235235g23gwrvsdb34g524rvqewwrv425gervqew...
29
+ responses:
30
+ 200:
31
+ description: If the email address is successfully verified, returns the string `"OK"`
32
+ content:
33
+ 'text/plain':
34
+ schema:
35
+ type: 'string'
36
+ value: OK
37
+ example: OK
38
+ description: The string `"OK"`
39
+ 401:
40
+ description: Returns a `"401 Bad Request"` if the code sent with the request is invalid
41
+ content:
42
+ 'application/json':
43
+ schema:
44
+ $ref: '#/components/schemas/Error'
45
+ example:
46
+ code: invalid_code
47
+ message: Invalid token
48
+ 500:
49
+ description: An unexpected error occurred
50
+ content:
51
+ 'application/json':
52
+ schema:
53
+ $ref: '#/components/schemas/UnexpectedError'
@@ -0,0 +1,67 @@
1
+ import { RouteInitEnvironment } from '../shared/env';
2
+ import { addMiddleware as addBearerAuthMiddleware } from '../middleware/user';
3
+ import { addRoute as addStateRoute } from './auth-state';
4
+ import { addRoute as addSignInRoute } from './auth-signin';
5
+ import { addRoute as addSignOutRoute } from './auth-signout';
6
+ import { addRoute as addVerifyEmailRoute } from './auth-verify-email';
7
+ import { addRoute as addResetPasswordRoute } from './auth-reset-password';
8
+ import { addRoute as addChangePasswordRoute } from './auth-change-password';
9
+ import { addRoute as addSignUpRoute } from './auth-signup';
10
+ import { addRoute as addUpdateRoute } from './auth-update';
11
+ import { addRoute as addDeleteRoute } from './auth-delete';
12
+ import { addRoute as addOAuth2InitRoute } from './oauth2-init';
13
+ import { addRoute as addOAuth2SignInRoute } from './oauth2-signin';
14
+ import { addRoute as addOAuth2RefreshRoute } from './oauth2-refresh';
15
+
16
+ export const addAuthenticionRoutes = (env: RouteInitEnvironment) => {
17
+ if (!env.config.auth.enabled) {
18
+ throw new Error('Authentication not enabled in the server settings');
19
+ }
20
+
21
+ // Bearer authentication middleware
22
+ addBearerAuthMiddleware(env);
23
+
24
+ // Auth state endpoint
25
+ addStateRoute(env);
26
+
27
+ // signin endpoint
28
+ addSignInRoute(env);
29
+
30
+ // signout endpoint
31
+ addSignOutRoute(env);
32
+
33
+ // verify email endpoint
34
+ const verifyEmailAddress = addVerifyEmailRoute(env);
35
+
36
+ // reset password endpoint
37
+ const resetPassword = addResetPasswordRoute(env);
38
+
39
+ // change password endpoint
40
+ addChangePasswordRoute(env);
41
+
42
+ // signup endpoint
43
+ addSignUpRoute(env);
44
+
45
+ // update enpoint
46
+ addUpdateRoute(env);
47
+
48
+ // delete endpoint
49
+ addDeleteRoute(env);
50
+
51
+ // OAuth2 init endpoint
52
+ addOAuth2InitRoute(env);
53
+
54
+ // OAuth2 signin endpoint
55
+ addOAuth2SignInRoute(env);
56
+
57
+ // OAuth2 token refresh endpoint
58
+ addOAuth2RefreshRoute(env);
59
+
60
+ // Return auth functions that can be used directly through an AceBaseServer instance
61
+ return {
62
+ verifyEmailAddress,
63
+ resetPassword
64
+ };
65
+ };
66
+
67
+ export default addAuthenticionRoutes;
@@ -0,0 +1,31 @@
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+ import { sendUnauthorizedError } from '../shared/error';
3
+
4
+ export type RequestQuery = null;
5
+ export type RequestBody = null;
6
+ export type ResponseBody = { exists: boolean };
7
+ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
8
+
9
+ export const addRoute = (env: RouteInitEnvironment) => {
10
+
11
+ env.app.get(`/exists/${env.db.name}/*`, async (req: Request, res) => {
12
+ // Exists query
13
+ const path = req.path.slice(env.db.name.length + 9);
14
+ const access = env.rules.userHasAccess(req.user, path, false);
15
+ if (!access.allow) {
16
+ return sendUnauthorizedError(res, access.code, access.message);
17
+ }
18
+
19
+ try {
20
+ const exists = await env.db.ref(path).exists();
21
+ res.send({ exists });
22
+ }
23
+ catch(err) {
24
+ res.statusCode = 500;
25
+ res.send(err);
26
+ }
27
+ });
28
+
29
+ };
30
+
31
+ export default addRoute;
@@ -0,0 +1,44 @@
1
+ /exists/{dbname}/{path}:
2
+ get:
3
+ tags:
4
+ - data
5
+ summary: Get existence of a path
6
+ description: Gets the existence of a path in the database
7
+ parameters:
8
+ - name: dbname
9
+ in: path
10
+ description: name of the database
11
+ required: true
12
+ schema:
13
+ type: string
14
+ example: mydb
15
+ - name: path
16
+ in: path
17
+ description: database path
18
+ required: true
19
+ schema:
20
+ type: string
21
+ example: collection/child/property
22
+ responses:
23
+ 200:
24
+ description: returns whether the target path exists in the database
25
+ content:
26
+ 'application/json':
27
+ schema:
28
+ type: object
29
+ properties:
30
+ exists:
31
+ type: boolean
32
+ example: true
33
+ 403:
34
+ description: Returns a "403 Forbidden" if the signed in user is not allowed to read from the target path
35
+ content:
36
+ 'application/json':
37
+ schema:
38
+ $ref: '#/components/schemas/Error'
39
+ 500:
40
+ description: An unexpected error occurred
41
+ content:
42
+ 'application/json':
43
+ schema:
44
+ $ref: '#/components/schemas/UnexpectedError'
@@ -0,0 +1,51 @@
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+ import { sendUnauthorizedError } from '../shared/error';
3
+
4
+ export type RequestQuery = {
5
+ format?: 'json';
6
+ type_safe?: '0'|'1'
7
+ };
8
+ export type RequestBody = null;
9
+ export type ResponseBody = any;
10
+ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
11
+
12
+ export const addRoute = (env: RouteInitEnvironment) => {
13
+
14
+ env.app.get(`/export/${env.db.name}/*`, async (req: Request, res) => {
15
+ // Export API
16
+ const path = req.path.slice(env.db.name.length + 9);
17
+ const access = env.rules.userHasAccess(req.user, path, false);
18
+ if (!access.allow) {
19
+ return sendUnauthorizedError(res, access.code, access.message);
20
+ }
21
+ const format = req.query.format || 'json';
22
+ const type_safe = req.query.type_safe !== '0';
23
+
24
+ const write = async (chunk) => {
25
+ let ok = res.write(chunk);
26
+ if (!ok) {
27
+ await new Promise(resolve => res.once('drain', resolve));
28
+ }
29
+ };
30
+
31
+ const ref = env.db.ref(path);
32
+ res.setHeader('Content-Disposition', `attachment; filename=${ref.key || 'export'}.json`); // Will be treated as a download in browser
33
+
34
+ try {
35
+ await ref.export(write, { format, type_safe });
36
+ }
37
+ catch (err) {
38
+ env.debug.error(`Error exporting data for path "/${path}": `, err);
39
+ if (!res.headersSent) {
40
+ res.statusCode = 500;
41
+ res.send(err);
42
+ }
43
+ }
44
+ finally {
45
+ res.end();
46
+ }
47
+ });
48
+
49
+ };
50
+
51
+ export default addRoute;
@@ -0,0 +1,64 @@
1
+ /export/{dbname}/{path}:
2
+ get:
3
+ tags:
4
+ - data
5
+ summary: Export (stream) the value of a path
6
+ description: Exports the value of a path in the database by streaming its content in a serialized format
7
+ parameters:
8
+ - name: dbname
9
+ in: path
10
+ description: name of the database
11
+ required: true
12
+ schema:
13
+ type: string
14
+ example: mydb
15
+ - name: path
16
+ in: path
17
+ description: database path
18
+ required: true
19
+ schema:
20
+ type: string
21
+ example: collection
22
+ - name: format
23
+ in: query
24
+ description: desired output format. Only `json` is currently supported
25
+ schema:
26
+ type: string
27
+ enum:
28
+ - json
29
+ example: json
30
+ - name: type_safe
31
+ in: query
32
+ description: Whether to add type information for data that has no native JSON representation (such as dates, binary data etc)
33
+ schema:
34
+ type: string
35
+ enum:
36
+ - 0
37
+ - 1
38
+ example: 1
39
+ responses:
40
+ 200:
41
+ description: Streams the data of requested path in the requested format. In the browser, this will trigger a file download.
42
+ headers:
43
+ 'Content-Disposition':
44
+ description: Tells the browser to download the data as a file
45
+ schema:
46
+ type: string
47
+ example: attachment; filename=[target_key].json
48
+ content:
49
+ 'text/plain':
50
+ schema:
51
+ type: object
52
+ example: {"l27mgh8r000009mhh84jdp9c":{"name":"My todo list","stats":{"size":216,"created":{".type":"date",".val":"2022-04-07T15:11:42.000Z"},"modified":{".type":"date",".val":"2022-03-08T12:24:05.000Z"}}},"l27mhwz2000109mh11yi7rbo":{"name":"Another child"},"l27mjf9k000209mhafylc3eo":{"name":"And another.."}}
53
+ 403:
54
+ description: Returns a "403 Forbidden" if the signed in user is not allowed to read from the target path
55
+ content:
56
+ 'application/json':
57
+ schema:
58
+ $ref: '#/components/schemas/Error'
59
+ 500:
60
+ description: An unexpected error occurred
61
+ content:
62
+ 'application/json':
63
+ schema:
64
+ $ref: '#/components/schemas/UnexpectedError'
@@ -0,0 +1,68 @@
1
+ import { Transport } from 'acebase-core';
2
+ import { SerializedValue } from 'acebase-core/types/transport';
3
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
4
+ import { sendUnauthorizedError } from '../shared/error';
5
+
6
+ export type RequestQuery = { include?: string; exclude?: string; child_objects?: boolean };
7
+ export type RequestBody = null;
8
+ export type ResponseBody = SerializedValue & { exists: boolean };
9
+ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
10
+
11
+ export const addRoute = (env: RouteInitEnvironment) => {
12
+
13
+ env.app.get(`/data/${env.db.name}/*`, async (req: Request, res) => {
14
+ // Request data
15
+ const path = req.path.slice(env.db.name.length + 7);
16
+ const access = env.rules.userHasAccess(req.user, path, false);
17
+ if (!access.allow) {
18
+ return sendUnauthorizedError(res, access.code, access.message);
19
+ }
20
+
21
+ const options: { include?: string[]; exclude?: string[]; child_objects?: boolean } = {};
22
+ if (req.query.include) {
23
+ options.include = req.query.include.split(',');
24
+ }
25
+ if (req.query.exclude) {
26
+ options.exclude = req.query.exclude.split(',');
27
+ }
28
+ if (typeof req.query.child_objects === 'boolean') {
29
+ options.child_objects = req.query.child_objects;
30
+ }
31
+
32
+ if (path === '') {
33
+ // If user has access to the root of database (NOT recommended for others than admin...)
34
+ // Do not return private server data. If the admin user wants access, they should use
35
+ // direct requests on those paths (GET /data/dbname/__auth__), or use reflection
36
+
37
+ if (options.include) {
38
+ // Remove all includes for private paths
39
+ options.include = options.include.filter(path => !path.startsWith('__'));
40
+ }
41
+ // Add private paths to exclude
42
+ options.exclude = [...options.exclude || [], '__auth__', '__log__'];
43
+ }
44
+
45
+ try {
46
+ // const snap = await db.ref(path).get(options);
47
+ // const value = snap.val(), context = snap.context();
48
+ const { value, context } = await env.db.api.get(path, options);
49
+ if (!env.config.transactions?.log) {
50
+ delete context.acebase_cursor;
51
+ }
52
+ const serialized = Transport.serialize(value);
53
+
54
+ res.setHeader('AceBase-Context', JSON.stringify(context));
55
+ res.send({
56
+ exists: value !== null,
57
+ val: serialized.val,
58
+ map: serialized.map
59
+ });
60
+ }
61
+ catch (err) {
62
+ res.status(500).send(err);
63
+ }
64
+ });
65
+
66
+ };
67
+
68
+ export default addRoute;
@@ -0,0 +1,54 @@
1
+ /data/{dbname}/{path}:
2
+ get:
3
+ tags:
4
+ - data
5
+ summary: Get the value of a path
6
+ description: Gets the stored value of a path in the database
7
+ parameters:
8
+ - name: dbname
9
+ in: path
10
+ description: name of the database
11
+ required: true
12
+ schema:
13
+ type: string
14
+ example: mydb
15
+ - name: path
16
+ in: path
17
+ description: database path
18
+ required: true
19
+ schema:
20
+ type: string
21
+ example: collection/child/property
22
+ responses:
23
+ 200:
24
+ description: Returns the serialized value of the target path, and whether it exists in the database
25
+ content:
26
+ 'application/json':
27
+ schema:
28
+ required:
29
+ - val
30
+ - exists
31
+ allOf:
32
+ - type: object
33
+ properties:
34
+ exists:
35
+ type: boolean
36
+ description: indicates if the path exists (when `false`, `val` property will be `null`)
37
+ example: true
38
+ - $ref: '#/components/schemas/SerializedValue'
39
+ example:
40
+ exists: true
41
+ val: { name: 'My todo list', stats: { size: 216, created: '2022-04-07T15:11:42Z', modified: '2022-03-08T12:24:05Z' } }
42
+ map: { 'stats/created': 'date', 'stats/modified': 'date' }
43
+ 403:
44
+ description: Returns a "403 Forbidden" if the signed in user is not allowed to read from the target path
45
+ content:
46
+ 'application/json':
47
+ schema:
48
+ $ref: '#/components/schemas/Error'
49
+ 500:
50
+ description: An unexpected error occurred
51
+ content:
52
+ 'application/json':
53
+ schema:
54
+ $ref: '#/components/schemas/UnexpectedError'
@@ -0,0 +1,56 @@
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+ import { sendUnauthorizedError } from '../shared/error';
3
+
4
+ export type RequestQuery = {
5
+ format?: 'json';
6
+ suppress_events?: '0'|'1'
7
+ };
8
+ export type RequestBody = null;
9
+ export type ResponseBody = { success: boolean; reason?: string };
10
+ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
11
+
12
+ export const addRoute = (env: RouteInitEnvironment) => {
13
+
14
+ env.app.post(`/import/${env.db.name}/*`, async (req: Request, res) => {
15
+ // Import API
16
+ const path = req.path.slice(env.db.name.length + 9);
17
+ const access = env.rules.userHasAccess(req.user, path, false);
18
+ if (!access.allow) {
19
+ return sendUnauthorizedError(res, access.code, access.message);
20
+ }
21
+ const format = req.query.format || 'json';
22
+ const suppress_events = req.query.suppress_events === '1';
23
+
24
+ req.pause(); // Switch to non-flowing mode so we can use .read() upon request
25
+ let eof = false;
26
+ req.once('end', () => { eof = true; });
27
+ const read = async (length: number) => {
28
+ let chunk = req.read();
29
+ if (chunk === null && !eof) {
30
+ await new Promise(resolve => req.once('readable', resolve));
31
+ chunk = req.read();
32
+ }
33
+ // env.debug.verbose(`Received chunk: `, chunk);
34
+ return chunk;
35
+ };
36
+
37
+ const ref = env.db.ref(path);
38
+ try {
39
+ await ref.import(read, { format, suppress_events });
40
+ res.send({ success: true });
41
+ }
42
+ catch (err) {
43
+ env.debug.error(`Error importing data for path "/${path}": `, err);
44
+ if (!res.headersSent) {
45
+ res.statusCode = 500;
46
+ res.send({ success: false, reason: err.message });
47
+ }
48
+ }
49
+ finally {
50
+ res.end();
51
+ }
52
+ });
53
+
54
+ };
55
+
56
+ export default addRoute;
@@ -0,0 +1,75 @@
1
+ /import/{dbname}/{path}:
2
+ post:
3
+ tags:
4
+ - data
5
+ summary: Import (stream) a new value for a path
6
+ description: Imports (streams) the sent data for a path into the database (beta functionality, currently not very fast)
7
+ parameters:
8
+ - name: dbname
9
+ in: path
10
+ description: name of the database
11
+ required: true
12
+ schema:
13
+ type: string
14
+ example: mydb
15
+ - name: path
16
+ in: path
17
+ description: database path
18
+ required: true
19
+ schema:
20
+ type: string
21
+ example: collection
22
+ - name: format
23
+ in: query
24
+ description: used data format. Only `json` is currently supported
25
+ schema:
26
+ type: string
27
+ enum:
28
+ - json
29
+ example: json
30
+ - name: suppress_events
31
+ in: query
32
+ description: Whether to suppress firing data change events during the import
33
+ schema:
34
+ type: string
35
+ enum:
36
+ - 0
37
+ - 1
38
+ example: 0
39
+ requestBody:
40
+ description: value to store in the database, can use typesafe values as exported by the _export_ endpoint
41
+ content:
42
+ 'text/plain':
43
+ schema:
44
+ type: object
45
+ example: {"l27mgh8r000009mhh84jdp9c":{"name":"My todo list","stats":{"size":216,"created":{".type":"date",".val":"2022-04-07T15:11:42.000Z"},"modified":{".type":"date",".val":"2022-03-08T12:24:05.000Z"}}},"l27mhwz2000109mh11yi7rbo":{"name":"Another child"},"l27mjf9k000209mhafylc3eo":{"name":"And another.."}}
46
+ responses:
47
+ 200:
48
+ description: Returns "200 OK" when the database operation succeeded
49
+ content:
50
+ 'application/json':
51
+ schema:
52
+ type: object
53
+ properties:
54
+ success:
55
+ type: boolean
56
+ example: true
57
+ 403:
58
+ description: Returns "403 Forbidden" if the signed in user is not allowed to write to the target path
59
+ content:
60
+ 'application/json':
61
+ schema:
62
+ $ref: '#/components/schemas/Error'
63
+ 500:
64
+ description: An error occurred
65
+ content:
66
+ 'application/json':
67
+ schema:
68
+ type: object
69
+ properties:
70
+ success:
71
+ type: boolean
72
+ example: false
73
+ reason:
74
+ type: string
75
+ example: Something went wrong