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,94 @@
1
+ import { IReflectionChildrenInfo, IReflectionNodeInfo, PathInfo } from 'acebase-core';
2
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
3
+ import { sendUnauthorizedError } from '../shared/error';
4
+
5
+ export type RequestQuery = { type: 'info'|'children'; impersonate?: string };
6
+ export type RequestBody = null;
7
+ export type ResponseBody = IReflectionNodeInfo & IReflectionChildrenInfo & { impersonation: {
8
+ uid: string;
9
+ read: {
10
+ allow: boolean;
11
+ error?: { code: string; message: string };
12
+ };
13
+ write: {
14
+ allow: boolean;
15
+ error?: { code: string; message: string };
16
+ };
17
+ }};
18
+ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
19
+
20
+ export const addRoute = (env: RouteInitEnvironment) => {
21
+
22
+ env.app.get(`/reflect/${env.db.name}/*`, async (req: Request, res) => {
23
+ // Reflection API
24
+ // if (!req.user || req.user.username !== 'admin') {
25
+ // return sendUnauthorizedError(res, 'admin_only', 'only admin can use reflection api');
26
+ // }
27
+ const path = req.path.slice(env.db.name.length + 10);
28
+ const access = env.rules.userHasAccess(req.user, path, false);
29
+ if (!access.allow) {
30
+ return sendUnauthorizedError(res, access.code, access.message);
31
+ }
32
+ const impersonatedAccess = {
33
+ uid: (!req.user || req.user.username !== 'admin') ? null : req.query.impersonate,
34
+ read: {
35
+ allow: false,
36
+ error: null
37
+ },
38
+ write: {
39
+ allow: false,
40
+ error: null
41
+ }
42
+ };
43
+ const impersonatedUser = impersonatedAccess.uid === 'anonymous' ? null : { uid: impersonatedAccess.uid };
44
+ if (impersonatedAccess.uid) {
45
+ const readAccess = env.rules.userHasAccess(impersonatedUser, path, false);
46
+ impersonatedAccess.read.allow = readAccess.allow;
47
+ if (!readAccess.allow) {
48
+ impersonatedAccess.read.error = { code: readAccess.code, message: readAccess.message };
49
+ }
50
+ const writeAccess = env.rules.userHasAccess(impersonatedUser, path, true);
51
+ impersonatedAccess.write.allow = writeAccess.allow;
52
+ if (!writeAccess.allow) {
53
+ impersonatedAccess.write.error = { code: writeAccess.code, message: writeAccess.message };
54
+ }
55
+ }
56
+ const type = req.query.type;
57
+ const args = {};
58
+ Object.keys(req.query).forEach(key => {
59
+ if (!['type','impersonate'].includes(key)) {
60
+ let val = req.query[key];
61
+ if (/^(?:true|false|[0-9]+)$/.test(val)) { val = JSON.parse(val); }
62
+ args[key] = val;
63
+ }
64
+ });
65
+
66
+ try {
67
+ const result: ResponseBody = await (env.db.ref(path).reflect as (type: string, args: any) => any)(type, args);
68
+ if (impersonatedAccess.uid) {
69
+ result.impersonation = impersonatedAccess;
70
+ let list;
71
+ if (type === 'children') {
72
+ list = result.list;
73
+ }
74
+ else if (type === 'info') {
75
+ list = typeof result.children === 'object' ? result.children.list : [];
76
+ }
77
+ list && list.forEach(childInfo => {
78
+ childInfo.access = {
79
+ read: env.rules.userHasAccess(impersonatedUser, PathInfo.getChildPath(path, childInfo.key), false).allow,
80
+ write: env.rules.userHasAccess(impersonatedUser, PathInfo.getChildPath(path, childInfo.key), true).allow
81
+ };
82
+ });
83
+ }
84
+ res.send(result);
85
+ }
86
+ catch (err) {
87
+ res.statusCode = 500;
88
+ res.send(err);
89
+ }
90
+ });
91
+
92
+ };
93
+
94
+ export default addRoute;
@@ -0,0 +1,124 @@
1
+ /reflect/{dbname}/{path}:
2
+ get:
3
+ tags:
4
+ - data
5
+ summary: Reflection
6
+ description: Gets information about a node and/or its children without loading any values. When signed in as the admin user, it is possible to include security info (read/write access rights) for an impersonated user
7
+ parameters:
8
+ - name: dbname
9
+ in: path
10
+ description: name of the database
11
+ required: true
12
+ schema:
13
+ type: string
14
+ example: mydb
15
+ - name: path
16
+ in: path
17
+ description: database path
18
+ required: true
19
+ schema:
20
+ type: string
21
+ example: collection/child/property
22
+ - name: type
23
+ in: query
24
+ description: reflection type
25
+ required: true
26
+ schema:
27
+ type: string
28
+ enum:
29
+ - info
30
+ - children
31
+ example: info
32
+ - name: include_child_count
33
+ in: query
34
+ required: false
35
+ description: if type is 'info', whether to include the child count
36
+ schema:
37
+ type: boolean
38
+ example: false
39
+ - name: child_limit
40
+ in: query
41
+ required: false
42
+ description: (for paging) if type is 'info', the max number of children to reflect. To skip previously acquired children, use in combination with `skip` or `from`
43
+ schema:
44
+ type: integer
45
+ example: 10
46
+ - name: child_skip
47
+ in: query
48
+ required: false
49
+ description: (for paging) if type is 'info', the number of children to skip
50
+ schema:
51
+ type: integer
52
+ example: 0
53
+ - name: child_from
54
+ in: query
55
+ required: false
56
+ description: (for paging) if type is 'info', the last child in previous reflection results to start enumerating
57
+ schema:
58
+ oneOf:
59
+ - type: string
60
+ description: key of the last enumerated child
61
+ - type: number
62
+ description: index of the last enumerated child
63
+ - name: limit
64
+ in: query
65
+ required: false
66
+ description: (for paging) if type is 'children', the max number of children to reflect. To skip previously acquired children, use in combination with `skip` or `from`
67
+ schema:
68
+ type: integer
69
+ example: 10
70
+ - name: skip
71
+ in: query
72
+ required: false
73
+ description: (for paging) if type is 'children', the number of children to skip
74
+ schema:
75
+ type: integer
76
+ example: 0
77
+ - name: from
78
+ in: query
79
+ required: false
80
+ description: (for paging) if type is 'children', the last child in previous reflection results to start enumerating
81
+ schema:
82
+ oneOf:
83
+ - type: string
84
+ description: key of the last enumerated child
85
+ - type: number
86
+ description: index of the last enumerated child
87
+ - name: impersonate
88
+ in: query
89
+ description: uid of the user to add access rights information for
90
+ required: false
91
+ schema:
92
+ type: string
93
+ responses:
94
+ 200:
95
+ description: Returns requested reflection info for the target path
96
+ content:
97
+ 'application/json':
98
+ schema:
99
+ oneOf:
100
+ - $ref: '#/components/schemas/ReflectionNodeInfo'
101
+ description: If reflection type is 'info'
102
+ - type: object
103
+ description: If reflection type is 'children'
104
+ properties:
105
+ more:
106
+ type: boolean
107
+ description: If there are more children
108
+ example: true
109
+ list:
110
+ type: array
111
+ items:
112
+ $ref: '#/components/schemas/ReflectionNodeInfo'
113
+ 403:
114
+ description: Returns a "403 Forbidden" if the signed in user is not allowed to read from the target path
115
+ content:
116
+ 'application/json':
117
+ schema:
118
+ $ref: '#/components/schemas/Error'
119
+ 500:
120
+ description: An unexpected error occurred
121
+ content:
122
+ 'application/json':
123
+ schema:
124
+ $ref: '#/components/schemas/UnexpectedError'
@@ -0,0 +1,38 @@
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+ import { sendError, sendUnauthorizedError } from '../shared/error';
3
+
4
+ export type RequestQuery = null;
5
+ export type RequestBody = null;
6
+ export type ResponseBody =
7
+ { path: string; schema: string; text: string } // 200
8
+ | 'Not Found'; // 410
9
+
10
+ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
11
+
12
+ export const addRoute = (env: RouteInitEnvironment) => {
13
+
14
+ env.app.get(`/schema/${env.db.name}/*`, async (req: Request, res) => {
15
+ // Get defined schema for a specifc path
16
+ if (!req.user || req.user.username !== 'admin') {
17
+ return sendUnauthorizedError(res, 'admin_only', 'only admin can perform schema operations');
18
+ }
19
+ try {
20
+ const path = req.path.slice(env.db.name.length + 9);
21
+ const schema = await env.db.schema.get(path);
22
+ if (!schema) {
23
+ return res.status(410).send('Not Found');
24
+ }
25
+ res.contentType('application/json').send({
26
+ path: schema.path,
27
+ schema: typeof schema.schema === 'string' ? schema.schema : schema.text,
28
+ text: schema.text
29
+ });
30
+ }
31
+ catch(err) {
32
+ sendError(res, err);
33
+ }
34
+ });
35
+
36
+ };
37
+
38
+ export default addRoute;
@@ -0,0 +1,53 @@
1
+ /schema/{dbname}/{path}:
2
+ get:
3
+ tags:
4
+ - data
5
+ - schemas
6
+ summary: Gets the schema defined on a path
7
+ description: Gets the schema defined on a specific path
8
+ parameters:
9
+ - name: dbname
10
+ in: path
11
+ description: name of the database
12
+ required: true
13
+ schema:
14
+ type: string
15
+ example: mydb
16
+ - name: path
17
+ in: path
18
+ description: database path
19
+ required: true
20
+ schema:
21
+ type: string
22
+ example: collection/item
23
+ responses:
24
+ 200:
25
+ description: Returns the defined schema on the target path
26
+ content:
27
+ 'application/json':
28
+ schema:
29
+ type: object
30
+ description: Object containing the string representation of the schema
31
+ example:
32
+ path: collection/child
33
+ schema: "{ name: string, stats?: { size: number, created: Date, modified: Date, deleted?: Date } }"
34
+ text: "{ name: string, stats?: { size: number, created: Date, modified: Date, deleted?: Date } }"
35
+ 403:
36
+ description: Returns a "403 Forbidden" if the signed in user is not admin
37
+ content:
38
+ 'application/json':
39
+ schema:
40
+ $ref: '#/components/schemas/Error'
41
+ 410:
42
+ description: Returns "410 Gone" if there is no schema definition on the requested path
43
+ content:
44
+ 'text/plain':
45
+ schema:
46
+ type: text
47
+ example: Not Found
48
+ 500:
49
+ description: An unexpected error occurred
50
+ content:
51
+ 'application/json':
52
+ schema:
53
+ $ref: '#/components/schemas/UnexpectedError'
@@ -0,0 +1,38 @@
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+ import { sendError, sendUnauthorizedError } from '../shared/error';
3
+
4
+ export type RequestQuery = null;
5
+ export type RequestBody = {
6
+ action?: 'set'; // deprecated
7
+ path: string;
8
+ schema: string|Object;
9
+ };
10
+ export type ResponseBody = { success: true } // 200
11
+ | { code: 'admin_only'; message: string } // 403
12
+ | { code: 'unexpected'; message: string }; // 500
13
+
14
+ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
15
+
16
+ export const addRoute = (env: RouteInitEnvironment) => {
17
+
18
+ env.app.post(`/schema/${env.db.name}`, async (req: Request, res) => {
19
+ // defines a schema
20
+ if (!req.user || req.user.username !== 'admin') {
21
+ return sendUnauthorizedError(res, 'admin_only', 'only admin can perform schema operations');
22
+ }
23
+
24
+ try {
25
+ const data = req.body;
26
+ const { path, schema } = data;
27
+ await env.db.schema.set(path, schema);
28
+
29
+ res.contentType('application/json').send({ success: true });
30
+ }
31
+ catch(err) {
32
+ sendError(res, err);
33
+ }
34
+ });
35
+
36
+ };
37
+
38
+ export default addRoute;
@@ -0,0 +1,60 @@
1
+ /schema/{dbname}:
2
+ post:
3
+ tags:
4
+ - data
5
+ - schemas
6
+ summary: Add a schema definition
7
+ description: Adds a schema definition to the specified path. This schema will be enabled while the server runs, and cleared upon restart. If you need the schema to be persisted, add it to your server's rules.json file
8
+ parameters:
9
+ - name: dbname
10
+ in: path
11
+ description: name of the database
12
+ required: true
13
+ schema:
14
+ type: string
15
+ example: mydb
16
+ requestBody:
17
+ description: details about the data and schema to test
18
+ content:
19
+ 'application/json':
20
+ schema:
21
+ type: object
22
+ properties:
23
+ action:
24
+ type: string
25
+ description: The desired operation `'set'` (optional, deprecated since v1.10.0)
26
+ example: set
27
+ path:
28
+ type: string
29
+ description: database path to the given value
30
+ example: collection/item
31
+ schema:
32
+ type: string
33
+ description: When given, tests this schema definition against the passed value instead of ones defined in the database
34
+ example: "{ name: string, stats?: { size: number, created: Date, modified: Date, deleted?: Date } }"
35
+ required:
36
+ - path
37
+ - schema
38
+ responses:
39
+ 200:
40
+ description: Returns "200 OK" if the schema was added successfully
41
+ content:
42
+ 'application/json':
43
+ schema:
44
+ type: object
45
+ properties:
46
+ success:
47
+ type: boolean
48
+ example: true
49
+ 403:
50
+ description: Returns a "403 Forbidden" if the signed in user is not admin
51
+ content:
52
+ 'application/json':
53
+ schema:
54
+ $ref: '#/components/schemas/Error'
55
+ 500:
56
+ description: An error occurred
57
+ content:
58
+ 'application/json':
59
+ schema:
60
+ $ref: '#/components/schemas/UnexpectedError'
@@ -0,0 +1,53 @@
1
+ import { ISchemaCheckResult, SchemaDefinition, Transport } from 'acebase-core';
2
+ import type { IAceBaseSchemaInfo } from 'acebase-core/src/api';
3
+ import type { SerializedValue } from 'acebase-core/types/transport';
4
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
5
+ import { sendError, sendUnauthorizedError } from '../shared/error';
6
+
7
+ export type RequestQuery = null;
8
+ export type RequestBody = {
9
+ value: SerializedValue;
10
+ partial: boolean;
11
+ path?: string;
12
+ schema?: IAceBaseSchemaInfo
13
+ };
14
+ export type ResponseBody = ISchemaCheckResult // 200
15
+ | { code: 'admin_only'; message: string } // 403
16
+ | { code: 'unexpected'; message: string }; // 500
17
+
18
+ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
19
+
20
+ export const addRoute = (env: RouteInitEnvironment) => {
21
+
22
+ env.app.post(`/schema/${env.db.name}/test`, async (req: Request, res) => {
23
+ // tests a schema
24
+ if (!req.user || req.user.username !== 'admin') {
25
+ return sendUnauthorizedError(res, 'admin_only', 'only admin can perform schema operations');
26
+ }
27
+
28
+ try {
29
+ const data = req.body;
30
+ if (typeof data.value?.val === 'undefined' || !['string','object','undefined'].includes(typeof data.value?.map)) {
31
+ return sendError(res, { code: 'invalid_serialized_value', message: 'The sent value is not properly serialized' });
32
+ }
33
+ const value = Transport.deserialize(data.value);
34
+ const { path, schema, partial } = data;
35
+ let result: ISchemaCheckResult;
36
+ if (schema) {
37
+ const definition = new SchemaDefinition(schema);
38
+ result = definition.check(path, value, partial);
39
+ }
40
+ else {
41
+ result = await env.db.schema.check(path, schema, partial);
42
+ }
43
+
44
+ res.contentType('application/json').send(result);
45
+ }
46
+ catch(err) {
47
+ sendError(res, err);
48
+ }
49
+ });
50
+
51
+ };
52
+
53
+ export default addRoute;
@@ -0,0 +1,66 @@
1
+ /schema/{dbname}/test:
2
+ post:
3
+ tags:
4
+ - data
5
+ - schemas
6
+ summary: Test a data schema
7
+ description: Tests an existing data schema in the database, or a given custom schema.
8
+ parameters:
9
+ - name: dbname
10
+ in: path
11
+ description: name of the database
12
+ required: true
13
+ schema:
14
+ type: string
15
+ example: mydb
16
+ requestBody:
17
+ description: details about the data and schema to test
18
+ content:
19
+ 'application/json':
20
+ schema:
21
+ type: object
22
+ properties:
23
+ path:
24
+ type: string
25
+ description: database path to the given value
26
+ example: collection/item
27
+ value:
28
+ $ref: '#/components/schemas/SerializedValue'
29
+ partial:
30
+ type: boolean
31
+ description: Whether to only test passed data (`update` db operation), or to validate the value against the entire schema (`set` db operation). Update operations allow required children in the schema not to be present in the passed value.
32
+ example: false
33
+ schema:
34
+ type: string
35
+ description: When given, tests this schema definition against the passed value instead of ones defined in the database
36
+ example: "{ name: string, stats?: { size: number, created: Date, modified: Date, deleted?: Date } }"
37
+ required:
38
+ - path
39
+ - value
40
+ - partial
41
+ responses:
42
+ 200:
43
+ description: Returns an object that indicates whether the value successfully validated against schema
44
+ content:
45
+ 'application/json':
46
+ schema:
47
+ type: object
48
+ properties:
49
+ ok:
50
+ type: boolean
51
+ example: false
52
+ reason:
53
+ type: string
54
+ example: path "books/book1/title" must be typeof string
55
+ 403:
56
+ description: Returns a "403 Forbidden" if the signed in user is not admin
57
+ content:
58
+ 'application/json':
59
+ schema:
60
+ $ref: '#/components/schemas/Error'
61
+ 500:
62
+ description: An unexpected error occurred
63
+ content:
64
+ 'application/json':
65
+ schema:
66
+ $ref: '#/components/schemas/UnexpectedError'
@@ -0,0 +1,33 @@
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+ import { sendError, sendUnauthorizedError } from '../shared/error';
3
+
4
+ export type RequestQuery = null;
5
+ export type RequestBody = null;
6
+ export type ResponseBody =
7
+ { path: string; schema: string; text: string }[] // 200
8
+
9
+ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
10
+
11
+ export const addRoute = (env: RouteInitEnvironment) => {
12
+
13
+ env.app.get(`/schema/${env.db.name}`, async (req: Request, res) => {
14
+ // Get all defined schemas
15
+ if (!req.user || req.user.username !== 'admin') {
16
+ return sendUnauthorizedError(res, 'admin_only', 'only admin can perform schema operations');
17
+ }
18
+ try {
19
+ const schemas = await env.db.schema.all();
20
+ res.contentType('application/json').send(schemas.map(schema => ({
21
+ path: schema.path,
22
+ schema: typeof schema.schema === 'string' ? schema.schema : schema.text,
23
+ text: schema.text
24
+ })));
25
+ }
26
+ catch(err) {
27
+ sendError(res, err);
28
+ }
29
+ });
30
+
31
+ };
32
+
33
+ export default addRoute;
@@ -0,0 +1,41 @@
1
+ /schema/{dbname}:
2
+ get:
3
+ tags:
4
+ - data
5
+ - schemas
6
+ summary: Gets all defined schema definitions
7
+ description: Gets a list of all defined schema definitions
8
+ parameters:
9
+ - name: dbname
10
+ in: path
11
+ description: name of the database
12
+ required: true
13
+ schema:
14
+ type: string
15
+ example: mydb
16
+ responses:
17
+ 200:
18
+ description: Returns all defined schemas in the database
19
+ content:
20
+ 'application/json':
21
+ schema:
22
+ type: array
23
+ items:
24
+ type: object
25
+ description: Object containing the string representation of the schema
26
+ example:
27
+ - path: collection/child
28
+ schema: "{ name: string, stats?: { size: number, created: Date, modified: Date, deleted?: Date } }"
29
+ text: "{ name: string, stats?: { size: number, created: Date, modified: Date, deleted?: Date } }"
30
+ 403:
31
+ description: Returns a "403 Forbidden" if the signed in user is not admin
32
+ content:
33
+ 'application/json':
34
+ schema:
35
+ $ref: '#/components/schemas/Error'
36
+ 500:
37
+ description: An unexpected error occurred
38
+ content:
39
+ 'application/json':
40
+ schema:
41
+ $ref: '#/components/schemas/UnexpectedError'
@@ -0,0 +1,76 @@
1
+ import { SchemaValidationError } from 'acebase';
2
+ import { Transport } from 'acebase-core';
3
+ import { SerializedValue } from 'acebase-core/types/transport';
4
+ import { RuleValidationFailCode } from '../rules';
5
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
6
+ import { sendBadRequestError, sendError, sendUnauthorizedError } from '../shared/error';
7
+
8
+ export class SetDataError extends Error {
9
+ constructor(public code: 'invalid_serialized_value', message: string) {
10
+ super(message);
11
+ }
12
+ }
13
+ export type RequestQuery = null;
14
+ export type RequestBody = SerializedValue; // { val: any; map?: string|Record<string, 'date'|'binary'|'reference'|'regexp'|'array'> };
15
+ export type ResponseBody = { success: true } // 200
16
+ | { code: 'invalid_serialized_value', message: string } // 400
17
+ | { code: RuleValidationFailCode, message: string } // 403
18
+ | { code: 'schema_validation_failed', message: string } // 422
19
+ | { code: string, message: string } // 500
20
+
21
+ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
22
+
23
+ export const addRoute = (env: RouteInitEnvironment) => {
24
+
25
+ env.app.put(`/data/${env.db.name}/*`, async (req: Request, res) => {
26
+ // Set data
27
+ const path = req.path.slice(env.db.name.length + 7);
28
+ const access = env.rules.userHasAccess(req.user, path, true);
29
+ if (!access.allow) {
30
+ return sendUnauthorizedError(res, access.code, access.message);
31
+ }
32
+
33
+ try {
34
+ const data = req.body;
35
+ if (typeof data?.val === 'undefined' || !['string','object','undefined'].includes(typeof data?.map)) {
36
+ throw new SetDataError('invalid_serialized_value', 'The sent value is not properly serialized');
37
+ }
38
+ const val = Transport.deserialize(data);
39
+
40
+ if (path === '' && req.user?.uid !== 'admin' && val !== null && typeof val === 'object') {
41
+ // Non-admin user: remove any private properties from the update object
42
+ Object.keys(val).filter(key => key.startsWith('__')).forEach(key => delete val[key]);
43
+ }
44
+
45
+ // Schema validation moved to storage, no need to check here but an early check won't do no harm!
46
+ const validation = await env.db.schema.check(path, val, false);
47
+ if (!validation.ok) {
48
+ throw new SchemaValidationError(validation.reason);
49
+ }
50
+
51
+ await env.db.ref(path)
52
+ .context(req.context)
53
+ .set(val);
54
+
55
+ res.send({ success: true });
56
+ }
57
+ catch(err) {
58
+ if (err instanceof SchemaValidationError) {
59
+ env.logRef?.push({ action: 'set_data', success: false, code: 'schema_validation_failed', path, error: err.reason, ip: req.ip, uid: req.user?.uid ?? null });
60
+ res.status(422).send({ code: 'schema_validation_failed', message: err.message });
61
+ }
62
+ else if (err instanceof SetDataError) {
63
+ env.logRef?.push({ action: 'set_data', success: false, code: err.code, path, ip: req.ip, uid: req.user?.uid ?? null });
64
+ sendBadRequestError(res, err);
65
+ }
66
+ else {
67
+ env.debug.error(`failed to set "${path}":`, err);
68
+ env.logRef?.push({ action: 'set_data', success: false, code: 'unknown_error', path, error: err.message, ip: req.ip, uid: req.user?.uid ?? null });
69
+ sendError(res, err);
70
+ }
71
+ };
72
+ });
73
+
74
+ };
75
+
76
+ export default addRoute;