acebase-server 1.13.3 → 1.14.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 (450) hide show
  1. package/create-package-files +25 -0
  2. package/dist/cjs/auth.js.map +1 -0
  3. package/dist/cjs/cluster.js.map +1 -0
  4. package/dist/cjs/index.d.ts +1 -1
  5. package/dist/cjs/index.js.map +1 -0
  6. package/dist/cjs/logger.js.map +1 -0
  7. package/dist/cjs/middleware/404.js.map +1 -0
  8. package/dist/cjs/middleware/admin-only.js.map +1 -0
  9. package/dist/cjs/middleware/cache.js.map +1 -0
  10. package/dist/cjs/middleware/connection.js.map +1 -0
  11. package/dist/cjs/middleware/context.js.map +1 -0
  12. package/dist/cjs/middleware/cors.js.map +1 -0
  13. package/dist/cjs/middleware/swagger.js.map +1 -0
  14. package/dist/cjs/middleware/user.js.map +1 -0
  15. package/dist/cjs/oauth-providers/dropbox.js.map +1 -0
  16. package/dist/cjs/oauth-providers/facebook.js.map +1 -0
  17. package/dist/cjs/oauth-providers/google.js.map +1 -0
  18. package/dist/cjs/oauth-providers/index.js.map +1 -0
  19. package/dist/cjs/oauth-providers/instagram.js.map +1 -0
  20. package/dist/cjs/oauth-providers/oauth-provider.js.map +1 -0
  21. package/dist/cjs/oauth-providers/spotify.js.map +1 -0
  22. package/dist/cjs/routes/auth-change-password.js.map +1 -0
  23. package/dist/cjs/routes/auth-delete.js.map +1 -0
  24. package/dist/cjs/routes/auth-forgot-password.js.map +1 -0
  25. package/dist/cjs/routes/auth-reset-password.js.map +1 -0
  26. package/dist/cjs/routes/auth-signin.js.map +1 -0
  27. package/dist/cjs/routes/auth-signout.js.map +1 -0
  28. package/dist/cjs/routes/auth-signup.js.map +1 -0
  29. package/dist/cjs/routes/auth-state.js.map +1 -0
  30. package/dist/cjs/routes/auth-update.js.map +1 -0
  31. package/dist/cjs/routes/auth-verify-email.js.map +1 -0
  32. package/dist/cjs/routes/auth.js.map +1 -0
  33. package/dist/cjs/routes/data-exists.js.map +1 -0
  34. package/dist/cjs/routes/data-export.js.map +1 -0
  35. package/dist/cjs/routes/data-get.js.map +1 -0
  36. package/dist/cjs/routes/data-import.js.map +1 -0
  37. package/dist/cjs/routes/data-index-create.js.map +1 -0
  38. package/dist/cjs/routes/data-index-delete.js.map +1 -0
  39. package/dist/cjs/routes/data-index-list.js.map +1 -0
  40. package/dist/cjs/routes/data-query.js.map +1 -0
  41. package/dist/cjs/routes/data-reflect.js.map +1 -0
  42. package/dist/cjs/routes/data-schema-get.js.map +1 -0
  43. package/dist/cjs/routes/data-schema-set.js.map +1 -0
  44. package/dist/cjs/routes/data-schema-test.js.map +1 -0
  45. package/dist/cjs/routes/data-schemas-list.js.map +1 -0
  46. package/dist/cjs/routes/data-set.js.map +1 -0
  47. package/dist/cjs/routes/data-sync-changes.js.map +1 -0
  48. package/dist/cjs/routes/data-sync-mutations.js.map +1 -0
  49. package/dist/cjs/routes/data-transaction.js.map +1 -0
  50. package/dist/cjs/routes/data-update.js.map +1 -0
  51. package/dist/cjs/routes/data.js.map +1 -0
  52. package/dist/cjs/routes/docs.js.map +1 -0
  53. package/dist/cjs/routes/meta-info.js.map +1 -0
  54. package/dist/cjs/routes/meta-logs.js.map +1 -0
  55. package/dist/cjs/routes/meta-ping.js.map +1 -0
  56. package/dist/cjs/routes/meta-stats.js.map +1 -0
  57. package/dist/cjs/routes/meta.js.map +1 -0
  58. package/dist/cjs/routes/oauth2-init.js.map +1 -0
  59. package/dist/cjs/routes/oauth2-refresh.js.map +1 -0
  60. package/dist/cjs/routes/oauth2-signin.js.map +1 -0
  61. package/dist/cjs/routes/webmanager.js.map +1 -0
  62. package/dist/cjs/rules.js +2 -9
  63. package/dist/cjs/rules.js.map +1 -0
  64. package/dist/cjs/schema/user.js.map +1 -0
  65. package/dist/cjs/server.js +1 -1
  66. package/dist/cjs/server.js.map +1 -0
  67. package/dist/cjs/settings/email.js.map +1 -0
  68. package/dist/cjs/settings/index.js +1 -1
  69. package/dist/cjs/settings/index.js.map +1 -0
  70. package/dist/cjs/shared/clients.js.map +1 -0
  71. package/dist/cjs/shared/email.js.map +1 -0
  72. package/dist/cjs/shared/env.js.map +1 -0
  73. package/dist/cjs/shared/error.js.map +1 -0
  74. package/dist/cjs/shared/http.js.map +1 -0
  75. package/dist/cjs/shared/password.js.map +1 -0
  76. package/dist/cjs/shared/rootpath.js.map +1 -0
  77. package/dist/cjs/shared/signin.js.map +1 -0
  78. package/dist/cjs/shared/simple-fetch.js.map +1 -0
  79. package/dist/cjs/shared/tokens.js.map +1 -0
  80. package/dist/cjs/shared/validate.js.map +1 -0
  81. package/dist/cjs/start.js.map +1 -0
  82. package/dist/cjs/test.js.map +1 -0
  83. package/dist/cjs/websocket/index.js.map +1 -0
  84. package/dist/cjs/websocket/manager.js +1 -1
  85. package/dist/cjs/websocket/manager.js.map +1 -0
  86. package/dist/cjs/websocket/socket.io.js.map +1 -0
  87. package/dist/esm/auth.js.map +1 -0
  88. package/dist/esm/cluster.js.map +1 -0
  89. package/dist/esm/index.d.ts +1 -1
  90. package/dist/esm/index.js.map +1 -0
  91. package/dist/esm/logger.js.map +1 -0
  92. package/dist/esm/middleware/404.js.map +1 -0
  93. package/dist/esm/middleware/admin-only.js.map +1 -0
  94. package/dist/esm/middleware/cache.js.map +1 -0
  95. package/dist/esm/middleware/connection.js.map +1 -0
  96. package/dist/esm/middleware/context.js.map +1 -0
  97. package/dist/esm/middleware/cors.js.map +1 -0
  98. package/dist/esm/middleware/swagger.js.map +1 -0
  99. package/dist/esm/middleware/user.js.map +1 -0
  100. package/dist/esm/oauth-providers/dropbox.js.map +1 -0
  101. package/dist/esm/oauth-providers/facebook.js.map +1 -0
  102. package/dist/esm/oauth-providers/google.js.map +1 -0
  103. package/dist/esm/oauth-providers/index.js.map +1 -0
  104. package/dist/esm/oauth-providers/instagram.js.map +1 -0
  105. package/dist/esm/oauth-providers/oauth-provider.js.map +1 -0
  106. package/dist/esm/oauth-providers/spotify.js.map +1 -0
  107. package/dist/esm/routes/auth-change-password.js.map +1 -0
  108. package/dist/esm/routes/auth-delete.js.map +1 -0
  109. package/dist/esm/routes/auth-forgot-password.js.map +1 -0
  110. package/dist/esm/routes/auth-reset-password.js.map +1 -0
  111. package/dist/esm/routes/auth-signin.js.map +1 -0
  112. package/dist/esm/routes/auth-signout.js.map +1 -0
  113. package/dist/esm/routes/auth-signup.js.map +1 -0
  114. package/dist/esm/routes/auth-state.js.map +1 -0
  115. package/dist/esm/routes/auth-update.js.map +1 -0
  116. package/dist/esm/routes/auth-verify-email.js.map +1 -0
  117. package/dist/esm/routes/auth.js.map +1 -0
  118. package/dist/esm/routes/data-exists.js.map +1 -0
  119. package/dist/esm/routes/data-export.js.map +1 -0
  120. package/dist/esm/routes/data-get.js.map +1 -0
  121. package/dist/esm/routes/data-import.js.map +1 -0
  122. package/dist/esm/routes/data-index-create.js.map +1 -0
  123. package/dist/esm/routes/data-index-delete.js.map +1 -0
  124. package/dist/esm/routes/data-index-list.js.map +1 -0
  125. package/dist/esm/routes/data-query.js.map +1 -0
  126. package/dist/esm/routes/data-reflect.js.map +1 -0
  127. package/dist/esm/routes/data-schema-get.js.map +1 -0
  128. package/dist/esm/routes/data-schema-set.js.map +1 -0
  129. package/dist/esm/routes/data-schema-test.js.map +1 -0
  130. package/dist/esm/routes/data-schemas-list.js.map +1 -0
  131. package/dist/esm/routes/data-set.js.map +1 -0
  132. package/dist/esm/routes/data-sync-changes.js.map +1 -0
  133. package/dist/esm/routes/data-sync-mutations.js.map +1 -0
  134. package/dist/esm/routes/data-transaction.js.map +1 -0
  135. package/dist/esm/routes/data-update.js.map +1 -0
  136. package/dist/esm/routes/data.js.map +1 -0
  137. package/dist/esm/routes/docs.js.map +1 -0
  138. package/dist/esm/routes/meta-info.js.map +1 -0
  139. package/dist/esm/routes/meta-logs.js.map +1 -0
  140. package/dist/esm/routes/meta-ping.js.map +1 -0
  141. package/dist/esm/routes/meta-stats.js.map +1 -0
  142. package/dist/esm/routes/meta.js.map +1 -0
  143. package/dist/esm/routes/oauth2-init.js.map +1 -0
  144. package/dist/esm/routes/oauth2-refresh.js.map +1 -0
  145. package/dist/esm/routes/oauth2-signin.js.map +1 -0
  146. package/dist/esm/routes/webmanager.js.map +1 -0
  147. package/dist/esm/rules.js +2 -9
  148. package/dist/esm/rules.js.map +1 -0
  149. package/dist/esm/schema/user.js.map +1 -0
  150. package/dist/esm/server.js +1 -1
  151. package/dist/esm/server.js.map +1 -0
  152. package/dist/esm/settings/email.js.map +1 -0
  153. package/dist/esm/settings/index.js +1 -1
  154. package/dist/esm/settings/index.js.map +1 -0
  155. package/dist/esm/shared/clients.js.map +1 -0
  156. package/dist/esm/shared/email.js.map +1 -0
  157. package/dist/esm/shared/env.js.map +1 -0
  158. package/dist/esm/shared/error.js.map +1 -0
  159. package/dist/esm/shared/http.js.map +1 -0
  160. package/dist/esm/shared/password.js.map +1 -0
  161. package/dist/esm/shared/rootpath.js.map +1 -0
  162. package/dist/esm/shared/signin.js.map +1 -0
  163. package/dist/esm/shared/simple-fetch.js.map +1 -0
  164. package/dist/esm/shared/tokens.js.map +1 -0
  165. package/dist/esm/shared/validate.js.map +1 -0
  166. package/dist/esm/start.js.map +1 -0
  167. package/dist/esm/test.js.map +1 -0
  168. package/dist/esm/websocket/index.js.map +1 -0
  169. package/dist/esm/websocket/manager.js +1 -1
  170. package/dist/esm/websocket/manager.js.map +1 -0
  171. package/dist/esm/websocket/socket.io.js.map +1 -0
  172. package/dist/types/auth.d.ts +1 -0
  173. package/dist/types/auth.d.ts.map +1 -0
  174. package/dist/types/cluster.d.ts +1 -0
  175. package/dist/types/cluster.d.ts.map +1 -0
  176. package/dist/types/index.d.ts +1 -0
  177. package/dist/types/index.d.ts.map +1 -0
  178. package/dist/types/logger.d.ts +1 -0
  179. package/dist/types/logger.d.ts.map +1 -0
  180. package/dist/types/middleware/404.d.ts +1 -0
  181. package/dist/types/middleware/404.d.ts.map +1 -0
  182. package/dist/types/middleware/admin-only.d.ts +1 -0
  183. package/dist/types/middleware/admin-only.d.ts.map +1 -0
  184. package/dist/types/middleware/cache.d.ts +1 -0
  185. package/dist/types/middleware/cache.d.ts.map +1 -0
  186. package/dist/types/middleware/connection.d.ts +1 -0
  187. package/dist/types/middleware/connection.d.ts.map +1 -0
  188. package/dist/types/middleware/context.d.ts +1 -0
  189. package/dist/types/middleware/context.d.ts.map +1 -0
  190. package/dist/types/middleware/cors.d.ts +1 -0
  191. package/dist/types/middleware/cors.d.ts.map +1 -0
  192. package/dist/types/middleware/swagger.d.ts +1 -0
  193. package/dist/types/middleware/swagger.d.ts.map +1 -0
  194. package/dist/types/middleware/user.d.ts +1 -0
  195. package/dist/types/middleware/user.d.ts.map +1 -0
  196. package/dist/types/oauth-providers/dropbox.d.ts +1 -0
  197. package/dist/types/oauth-providers/dropbox.d.ts.map +1 -0
  198. package/dist/types/oauth-providers/facebook.d.ts +1 -0
  199. package/dist/types/oauth-providers/facebook.d.ts.map +1 -0
  200. package/dist/types/oauth-providers/google.d.ts +1 -0
  201. package/dist/types/oauth-providers/google.d.ts.map +1 -0
  202. package/dist/types/oauth-providers/index.d.ts +1 -0
  203. package/dist/types/oauth-providers/index.d.ts.map +1 -0
  204. package/dist/types/oauth-providers/instagram.d.ts +1 -0
  205. package/dist/types/oauth-providers/instagram.d.ts.map +1 -0
  206. package/dist/types/oauth-providers/oauth-provider.d.ts +1 -0
  207. package/dist/types/oauth-providers/oauth-provider.d.ts.map +1 -0
  208. package/dist/types/oauth-providers/spotify.d.ts +1 -0
  209. package/dist/types/oauth-providers/spotify.d.ts.map +1 -0
  210. package/dist/types/routes/auth-change-password.d.ts +1 -0
  211. package/dist/types/routes/auth-change-password.d.ts.map +1 -0
  212. package/dist/types/routes/auth-delete.d.ts +1 -0
  213. package/dist/types/routes/auth-delete.d.ts.map +1 -0
  214. package/dist/types/routes/auth-forgot-password.d.ts +1 -0
  215. package/dist/types/routes/auth-forgot-password.d.ts.map +1 -0
  216. package/dist/types/routes/auth-reset-password.d.ts +1 -0
  217. package/dist/types/routes/auth-reset-password.d.ts.map +1 -0
  218. package/dist/types/routes/auth-signin.d.ts +1 -0
  219. package/dist/types/routes/auth-signin.d.ts.map +1 -0
  220. package/dist/types/routes/auth-signout.d.ts +1 -0
  221. package/dist/types/routes/auth-signout.d.ts.map +1 -0
  222. package/dist/types/routes/auth-signup.d.ts +1 -0
  223. package/dist/types/routes/auth-signup.d.ts.map +1 -0
  224. package/dist/types/routes/auth-state.d.ts +1 -0
  225. package/dist/types/routes/auth-state.d.ts.map +1 -0
  226. package/dist/types/routes/auth-update.d.ts +1 -0
  227. package/dist/types/routes/auth-update.d.ts.map +1 -0
  228. package/dist/types/routes/auth-verify-email.d.ts +1 -0
  229. package/dist/types/routes/auth-verify-email.d.ts.map +1 -0
  230. package/dist/types/routes/auth.d.ts +1 -0
  231. package/dist/types/routes/auth.d.ts.map +1 -0
  232. package/dist/types/routes/data-exists.d.ts +1 -0
  233. package/dist/types/routes/data-exists.d.ts.map +1 -0
  234. package/dist/types/routes/data-export.d.ts +1 -0
  235. package/dist/types/routes/data-export.d.ts.map +1 -0
  236. package/dist/types/routes/data-get.d.ts +3 -2
  237. package/dist/types/routes/data-get.d.ts.map +1 -0
  238. package/dist/types/routes/data-import.d.ts +1 -0
  239. package/dist/types/routes/data-import.d.ts.map +1 -0
  240. package/dist/types/routes/data-index-create.d.ts +1 -0
  241. package/dist/types/routes/data-index-create.d.ts.map +1 -0
  242. package/dist/types/routes/data-index-delete.d.ts +1 -0
  243. package/dist/types/routes/data-index-delete.d.ts.map +1 -0
  244. package/dist/types/routes/data-index-list.d.ts +1 -0
  245. package/dist/types/routes/data-index-list.d.ts.map +1 -0
  246. package/dist/types/routes/data-query.d.ts +1 -0
  247. package/dist/types/routes/data-query.d.ts.map +1 -0
  248. package/dist/types/routes/data-reflect.d.ts +1 -0
  249. package/dist/types/routes/data-reflect.d.ts.map +1 -0
  250. package/dist/types/routes/data-schema-get.d.ts +1 -0
  251. package/dist/types/routes/data-schema-get.d.ts.map +1 -0
  252. package/dist/types/routes/data-schema-set.d.ts +2 -1
  253. package/dist/types/routes/data-schema-set.d.ts.map +1 -0
  254. package/dist/types/routes/data-schema-test.d.ts +3 -4
  255. package/dist/types/routes/data-schema-test.d.ts.map +1 -0
  256. package/dist/types/routes/data-schemas-list.d.ts +1 -0
  257. package/dist/types/routes/data-schemas-list.d.ts.map +1 -0
  258. package/dist/types/routes/data-set.d.ts +3 -2
  259. package/dist/types/routes/data-set.d.ts.map +1 -0
  260. package/dist/types/routes/data-sync-changes.d.ts +2 -1
  261. package/dist/types/routes/data-sync-changes.d.ts.map +1 -0
  262. package/dist/types/routes/data-sync-mutations.d.ts +2 -1
  263. package/dist/types/routes/data-sync-mutations.d.ts.map +1 -0
  264. package/dist/types/routes/data-transaction.d.ts +3 -2
  265. package/dist/types/routes/data-transaction.d.ts.map +1 -0
  266. package/dist/types/routes/data-update.d.ts +3 -2
  267. package/dist/types/routes/data-update.d.ts.map +1 -0
  268. package/dist/types/routes/data.d.ts +1 -0
  269. package/dist/types/routes/data.d.ts.map +1 -0
  270. package/dist/types/routes/docs.d.ts +1 -0
  271. package/dist/types/routes/docs.d.ts.map +1 -0
  272. package/dist/types/routes/meta-info.d.ts +1 -0
  273. package/dist/types/routes/meta-info.d.ts.map +1 -0
  274. package/dist/types/routes/meta-logs.d.ts +2 -1
  275. package/dist/types/routes/meta-logs.d.ts.map +1 -0
  276. package/dist/types/routes/meta-ping.d.ts +1 -0
  277. package/dist/types/routes/meta-ping.d.ts.map +1 -0
  278. package/dist/types/routes/meta-stats.d.ts +1 -0
  279. package/dist/types/routes/meta-stats.d.ts.map +1 -0
  280. package/dist/types/routes/meta.d.ts +1 -0
  281. package/dist/types/routes/meta.d.ts.map +1 -0
  282. package/dist/types/routes/oauth2-init.d.ts +1 -0
  283. package/dist/types/routes/oauth2-init.d.ts.map +1 -0
  284. package/dist/types/routes/oauth2-refresh.d.ts +1 -0
  285. package/dist/types/routes/oauth2-refresh.d.ts.map +1 -0
  286. package/dist/types/routes/oauth2-signin.d.ts +1 -0
  287. package/dist/types/routes/oauth2-signin.d.ts.map +1 -0
  288. package/dist/types/routes/webmanager.d.ts +1 -0
  289. package/dist/types/routes/webmanager.d.ts.map +1 -0
  290. package/dist/types/rules.d.ts +1 -7
  291. package/dist/types/rules.d.ts.map +1 -0
  292. package/dist/types/schema/user.d.ts +1 -0
  293. package/dist/types/schema/user.d.ts.map +1 -0
  294. package/dist/types/server.d.ts +1 -0
  295. package/dist/types/server.d.ts.map +1 -0
  296. package/dist/types/settings/email.d.ts +1 -0
  297. package/dist/types/settings/email.d.ts.map +1 -0
  298. package/dist/types/settings/index.d.ts +2 -1
  299. package/dist/types/settings/index.d.ts.map +1 -0
  300. package/dist/types/shared/clients.d.ts +4 -3
  301. package/dist/types/shared/clients.d.ts.map +1 -0
  302. package/dist/types/shared/email.d.ts +1 -0
  303. package/dist/types/shared/email.d.ts.map +1 -0
  304. package/dist/types/shared/env.d.ts +2 -2
  305. package/dist/types/shared/env.d.ts.map +1 -0
  306. package/dist/types/shared/error.d.ts +1 -0
  307. package/dist/types/shared/error.d.ts.map +1 -0
  308. package/dist/types/shared/http.d.ts +1 -0
  309. package/dist/types/shared/http.d.ts.map +1 -0
  310. package/dist/types/shared/password.d.ts +1 -0
  311. package/dist/types/shared/password.d.ts.map +1 -0
  312. package/dist/types/shared/rootpath.d.ts +1 -0
  313. package/dist/types/shared/rootpath.d.ts.map +1 -0
  314. package/dist/types/shared/signin.d.ts +1 -0
  315. package/dist/types/shared/signin.d.ts.map +1 -0
  316. package/dist/types/shared/simple-fetch.d.ts +1 -0
  317. package/dist/types/shared/simple-fetch.d.ts.map +1 -0
  318. package/dist/types/shared/tokens.d.ts +1 -0
  319. package/dist/types/shared/tokens.d.ts.map +1 -0
  320. package/dist/types/shared/validate.d.ts +1 -0
  321. package/dist/types/shared/validate.d.ts.map +1 -0
  322. package/dist/types/start.d.ts +1 -0
  323. package/dist/types/start.d.ts.map +1 -0
  324. package/dist/types/test.d.ts +1 -0
  325. package/dist/types/test.d.ts.map +1 -0
  326. package/dist/types/websocket/index.d.ts +1 -0
  327. package/dist/types/websocket/index.d.ts.map +1 -0
  328. package/dist/types/websocket/manager.d.ts +11 -10
  329. package/dist/types/websocket/manager.d.ts.map +1 -0
  330. package/dist/types/websocket/socket.io.d.ts +1 -0
  331. package/dist/types/websocket/socket.io.d.ts.map +1 -0
  332. package/package.json +3 -3
  333. package/src/auth.ts +87 -0
  334. package/src/cluster.ts +62 -0
  335. package/src/index.ts +4 -0
  336. package/src/logger.ts +56 -0
  337. package/src/middleware/404.ts +13 -0
  338. package/src/middleware/admin-only.ts +29 -0
  339. package/src/middleware/cache.ts +15 -0
  340. package/src/middleware/connection.ts +48 -0
  341. package/src/middleware/context.ts +23 -0
  342. package/src/middleware/cors.ts +49 -0
  343. package/src/middleware/swagger.ts +19 -0
  344. package/src/middleware/user.ts +51 -0
  345. package/src/oauth-providers/dropbox.ts +144 -0
  346. package/src/oauth-providers/facebook.ts +103 -0
  347. package/src/oauth-providers/google.ts +147 -0
  348. package/src/oauth-providers/index.ts +21 -0
  349. package/src/oauth-providers/instagram.ts +98 -0
  350. package/src/oauth-providers/oauth-provider.ts +65 -0
  351. package/src/oauth-providers/spotify.ts +127 -0
  352. package/src/placeholder.d.ts +12 -0
  353. package/src/routes/auth-change-password.ts +92 -0
  354. package/src/routes/auth-change-password.yaml +74 -0
  355. package/src/routes/auth-delete.ts +49 -0
  356. package/src/routes/auth-delete.yaml +78 -0
  357. package/src/routes/auth-forgot-password.ts +77 -0
  358. package/src/routes/auth-forgot-password.yaml +50 -0
  359. package/src/routes/auth-reset-password.ts +96 -0
  360. package/src/routes/auth-reset-password.yaml +54 -0
  361. package/src/routes/auth-signin.ts +55 -0
  362. package/src/routes/auth-signin.yaml +130 -0
  363. package/src/routes/auth-signout.ts +64 -0
  364. package/src/routes/auth-signout.yaml +46 -0
  365. package/src/routes/auth-signup.ts +164 -0
  366. package/src/routes/auth-signup.yaml +136 -0
  367. package/src/routes/auth-state.ts +20 -0
  368. package/src/routes/auth-state.yaml +29 -0
  369. package/src/routes/auth-update.ts +149 -0
  370. package/src/routes/auth-update.yaml +152 -0
  371. package/src/routes/auth-verify-email.ts +75 -0
  372. package/src/routes/auth-verify-email.yaml +53 -0
  373. package/src/routes/auth.ts +67 -0
  374. package/src/routes/data-exists.ts +31 -0
  375. package/src/routes/data-exists.yaml +44 -0
  376. package/src/routes/data-export.ts +51 -0
  377. package/src/routes/data-export.yaml +64 -0
  378. package/src/routes/data-get.ts +67 -0
  379. package/src/routes/data-get.yaml +54 -0
  380. package/src/routes/data-import.ts +56 -0
  381. package/src/routes/data-import.yaml +75 -0
  382. package/src/routes/data-index-create.ts +82 -0
  383. package/src/routes/data-index-create.yaml +105 -0
  384. package/src/routes/data-index-delete.ts +36 -0
  385. package/src/routes/data-index-delete.yaml +51 -0
  386. package/src/routes/data-index-list.ts +39 -0
  387. package/src/routes/data-index-list.yaml +84 -0
  388. package/src/routes/data-query.ts +97 -0
  389. package/src/routes/data-query.yaml +166 -0
  390. package/src/routes/data-reflect.ts +91 -0
  391. package/src/routes/data-reflect.yaml +124 -0
  392. package/src/routes/data-schema-get.ts +36 -0
  393. package/src/routes/data-schema-get.yaml +53 -0
  394. package/src/routes/data-schema-set.ts +35 -0
  395. package/src/routes/data-schema-set.yaml +60 -0
  396. package/src/routes/data-schema-test.ts +48 -0
  397. package/src/routes/data-schema-test.yaml +66 -0
  398. package/src/routes/data-schemas-list.ts +31 -0
  399. package/src/routes/data-schemas-list.yaml +41 -0
  400. package/src/routes/data-set.ts +83 -0
  401. package/src/routes/data-set.yaml +77 -0
  402. package/src/routes/data-sync-changes.ts +77 -0
  403. package/src/routes/data-sync-changes.yaml +67 -0
  404. package/src/routes/data-sync-mutations.ts +77 -0
  405. package/src/routes/data-sync-mutations.yaml +67 -0
  406. package/src/routes/data-transaction-finish.yaml +82 -0
  407. package/src/routes/data-transaction-start.yaml +58 -0
  408. package/src/routes/data-transaction.ts +166 -0
  409. package/src/routes/data-update.ts +84 -0
  410. package/src/routes/data-update.yaml +77 -0
  411. package/src/routes/data.ts +79 -0
  412. package/src/routes/docs.ts +249 -0
  413. package/src/routes/meta-info.ts +80 -0
  414. package/src/routes/meta-info.yaml +41 -0
  415. package/src/routes/meta-logs.ts +57 -0
  416. package/src/routes/meta-ping.ts +15 -0
  417. package/src/routes/meta-ping.yaml +23 -0
  418. package/src/routes/meta-stats.ts +31 -0
  419. package/src/routes/meta-stats.yaml +41 -0
  420. package/src/routes/meta.ts +22 -0
  421. package/src/routes/oauth2-init.ts +44 -0
  422. package/src/routes/oauth2-init.yaml +63 -0
  423. package/src/routes/oauth2-refresh.ts +39 -0
  424. package/src/routes/oauth2-refresh.yaml +65 -0
  425. package/src/routes/oauth2-signin.ts +286 -0
  426. package/src/routes/oauth2-signin.yaml +66 -0
  427. package/src/routes/webmanager.ts +29 -0
  428. package/src/rules.ts +189 -0
  429. package/src/schema/user.ts +99 -0
  430. package/src/server.ts +419 -0
  431. package/src/settings/email.ts +18 -0
  432. package/src/settings/index.ts +241 -0
  433. package/src/shared/clients.ts +31 -0
  434. package/src/shared/email.ts +33 -0
  435. package/src/shared/env.ts +38 -0
  436. package/src/shared/error.ts +37 -0
  437. package/src/shared/http.ts +26 -0
  438. package/src/shared/password.ts +41 -0
  439. package/src/shared/rootpath.ts +17 -0
  440. package/src/shared/signin.ts +149 -0
  441. package/src/shared/simple-fetch.ts +65 -0
  442. package/src/shared/tokens.ts +77 -0
  443. package/src/shared/validate.ts +53 -0
  444. package/src/start.ts +48 -0
  445. package/src/test.ts +10 -0
  446. package/src/websocket/index.ts +336 -0
  447. package/src/websocket/manager.ts +46 -0
  448. package/src/websocket/socket.io.ts +90 -0
  449. package/tsconfig-cjs.json +11 -0
  450. package/tsconfig.json +22 -0
@@ -0,0 +1,79 @@
1
+ import { RouteInitEnvironment } from "../shared/env";
2
+ import addContextMiddleware from "../middleware/context";
3
+ import addGetDataRoute from './data-get';
4
+ import addUpdateDataRoute from './data-update';
5
+ import addSetDataRoute from './data-set';
6
+ import addTransactionRoutes from './data-transaction';
7
+ import addExistsRoute from './data-exists';
8
+ import addReflectRoute from './data-reflect';
9
+ import addImportDataRoute from './data-import';
10
+ import addExportDataRoute from './data-export';
11
+ import addQueryRoute from './data-query';
12
+
13
+ // Indexes:
14
+ import addListIndexesRoute from './data-index-list';
15
+ import addCreateIndexRoute from './data-index-create';
16
+ import addDeleteIndexRoute from './data-index-delete';
17
+
18
+ // Schemas:
19
+ import addListSchemasRoute from './data-schemas-list';
20
+ import addGetSchemaRoute from './data-schema-get';
21
+ import addSetSchemaRoute from './data-schema-set';
22
+ import addTestSchemaRoute from './data-schema-test';
23
+
24
+ // Sycnronization:
25
+ import addSyncMutationsRoute from './data-sync-mutations';
26
+ import addSyncChangesRoute from './data-sync-changes';
27
+
28
+ export const addRoutes = (env: RouteInitEnvironment) => {
29
+
30
+ // Add context middleware that handles AceBase-Context header
31
+ addContextMiddleware(env);
32
+
33
+ // Add get data endpoint
34
+ addGetDataRoute(env);
35
+
36
+ // Add update data endpoint
37
+ addUpdateDataRoute(env);
38
+
39
+ // Add set data endpoint
40
+ addSetDataRoute(env);
41
+
42
+ // add transaction routes (start & finish)
43
+ addTransactionRoutes(env);
44
+
45
+ // Add exists endpoint
46
+ addExistsRoute(env);
47
+
48
+ // Add reflect endpoint
49
+ addReflectRoute(env);
50
+
51
+ // Add import endpoint
52
+ addImportDataRoute(env);
53
+
54
+ // Add export endpoint
55
+ addExportDataRoute(env);
56
+
57
+ // Add query endpoint
58
+ addQueryRoute(env);
59
+
60
+ // Add index endpoints:
61
+ addListIndexesRoute(env); // list indexes
62
+ addCreateIndexRoute(env); // create index
63
+ addDeleteIndexRoute(env); // delete index
64
+
65
+ // Add schema endpoints:
66
+ addListSchemasRoute(env); // list all
67
+ addGetSchemaRoute(env); // get schema
68
+ addSetSchemaRoute(env); // set schema
69
+ addTestSchemaRoute(env); // test
70
+
71
+ // Add sync mutations endpoint
72
+ addSyncMutationsRoute(env);
73
+
74
+ // add sync changes endpoint
75
+ addSyncChangesRoute(env);
76
+
77
+ };
78
+
79
+ export default addRoutes;
@@ -0,0 +1,249 @@
1
+ import * as swaggerJsdoc from 'swagger-jsdoc';
2
+ const createSwaggerDocs = (swaggerJsdoc as any).default ?? swaggerJsdoc; // ESM and CJS compatible approach
3
+ import * as _swaggerUi from 'swagger-ui-express';
4
+ const swaggerUi = (_swaggerUi as any).default ?? _swaggerUi; // ESM and CJS compatible approach
5
+ import { RouteInitEnvironment } from '../shared/env';
6
+ import { packageRootPath } from '../shared/rootpath';
7
+ import { join as joinPaths } from 'path';
8
+
9
+ const yamlPath = joinPaths(packageRootPath, '/src/routes/*.yaml');
10
+ // console.log(`Using path ${yamlPath} for Swagger documentation`);
11
+
12
+ export const addRoute = (env: RouteInitEnvironment) => {
13
+
14
+ // Generate docs from all yaml files
15
+ const options:swaggerJsdoc.Options = {
16
+ definition: {
17
+ openapi: '3.0.0',
18
+ info: {
19
+ title: 'AceBase Server',
20
+ description: 'AceBase Server API endpoint documentation and test environment. This documentation is available on the server because it is running in development mode. To disable this, set your NODE_ENV environment variable to production. Many endpoints require you to authenticate using Bearer authentication. Use the _/auth/{dbname}/signin_ endpoint to obtain an access token, then click the _Authorize_ button and paste your token into the input field. For more information about AceBase, see GitHub',
21
+ version: '1.10.0',
22
+ contact: {
23
+ name: 'AceBase API Support',
24
+ email: 'me@appy.one',
25
+ url: 'https://github.com/appy-one/acebase-server'
26
+ },
27
+ // servers: [`http://${config.server.host}:${config.server.port}`]
28
+ },
29
+ tags: [{
30
+ name: 'auth',
31
+ description: 'User authentication endpoints'
32
+ }, {
33
+ name: 'oauth2',
34
+ description: 'User authentication using 3rd party OAuth2 providers'
35
+ }, {
36
+ name: 'data',
37
+ description: 'Data manipulation and query endpoints'
38
+ }, {
39
+ name: 'indexes',
40
+ description: 'Index management endpoints'
41
+ }, {
42
+ name: 'schemas',
43
+ description: 'Data schema management endpoints'
44
+ }, {
45
+ name: 'metadata',
46
+ description: 'Metadata endpoints'
47
+ }],
48
+ components: {
49
+ securitySchemes: {
50
+ bearerAuth: {
51
+ type: 'http',
52
+ scheme: 'bearer',
53
+ bearerFormat: 'token' // switch to JWT in the future?
54
+ }
55
+ },
56
+ schemas: {
57
+ User: {
58
+ type: 'object',
59
+ properties: {
60
+ uid: { type: 'string', example: 'jpx0k53u0002ecr7s354c51l' },
61
+ username: { type: 'string', example: 'someuser' },
62
+ email: { type: 'string', example: 'email@domain.com' },
63
+ displayName: { type: 'string', example: 'Some User' },
64
+ picture: {
65
+ type: 'object',
66
+ properties: {
67
+ width: { type: 'number', example: 500 },
68
+ height: { type: 'number', example: 500 },
69
+ url: { type: 'string', example: 'https://profile.pic/user.jpg' }
70
+ }
71
+ },
72
+ emailVerified: { type: 'boolean', example: true },
73
+ created: { type: 'string', example: '2022-03-09T15:38:57.361Z' },
74
+ prevSignin: { type: 'string', example: '2022-03-09T15:38:57.361Z' },
75
+ prevSigninIp: { type: 'string', example: '127.0.0.1' },
76
+ lastSignin: { type: 'string', example: '2022-03-09T15:38:57.361Z' },
77
+ lastSigninIp: { type: 'string', example: '127.0.0.1' },
78
+ changePassword: { type: 'boolean', example: false },
79
+ changePasswordRequested: { type: 'boolean', example: false },
80
+ changePasswordBefore: { type: 'string', example: '2022-03-09T15:38:57.361Z' },
81
+ settings: { type: 'object' }
82
+ }
83
+ },
84
+ Error: {
85
+ type: 'object',
86
+ properties: {
87
+ code: { type: 'string', description: 'error code', example: 'invalid_request' },
88
+ message: { type: 'string', description: 'The error message', example: 'Invalid request for this endpoint' }
89
+ }
90
+ },
91
+ UnexpectedError: {
92
+ type: 'object',
93
+ properties: {
94
+ code: { type: 'string', value: 'unexpected', description: 'The string `"unexpected"`' },
95
+ message: { type: 'string', description: 'The server error message' }
96
+ }
97
+ },
98
+ UnknownError: {
99
+ type: 'object',
100
+ properties: {
101
+ code: { type: 'string', value: 'unknown', description: 'The string `"unknown"`' },
102
+ message: { type: 'string', description: 'The server error message' }
103
+ }
104
+ },
105
+ SchemaValidationError: {
106
+ type: 'object',
107
+ properties: {
108
+ code: { type: 'string', description: 'The string `"schema_validation_failed"`', example: 'schema_validation_failed' },
109
+ message: { type: 'string', description: 'The server error message', example: 'Property at path "path/property" is of the wrong type' }
110
+ }
111
+ },
112
+ SerializedValue: {
113
+ type: 'object',
114
+ properties: {
115
+ val: {
116
+ description: 'Any value (serialized for transport)',
117
+ oneOf: [
118
+ { type: 'string' },
119
+ { type: 'number' },
120
+ { type: 'integer' },
121
+ { type: 'boolean' },
122
+ { type: 'object' },
123
+ { type: 'array' }
124
+ ],
125
+ example: '2022-04-07T16:36:21Z',
126
+ required: true
127
+ },
128
+ map: {
129
+ description: 'If the value has been serialized for transport, contains a string defining `val`s data type (eg `"date"` or `"binary"`), or an object with deep property mappings for an object value in `val`',
130
+ oneOf: [
131
+ { type: 'string', example: 'date' },
132
+ { type: 'object', example: { 'stats/created': 'date' } }
133
+ ],
134
+ example: 'date',
135
+ required: false
136
+ }
137
+ },
138
+ required: ['val'],
139
+ example: {
140
+ val: { name: 'My todo list', stats: { size: 216, created: '2022-04-07T15:11:42Z', modified: '2022-03-08T12:24:05Z' } },
141
+ map: { 'stats/created': 'date', 'stats/modified': 'date' }
142
+ }
143
+ },
144
+ ReflectionNodeInfo: {
145
+ type: 'object',
146
+ required: ['key', 'exists', 'type'],
147
+ properties: {
148
+ key: {
149
+ description: 'Key or index of the node',
150
+ oneOf: [{
151
+ type: 'string',
152
+ description: 'key of the node',
153
+ example: 'jld2cjxh0000qzrmn831i7rn'
154
+ }, {
155
+ type: 'number',
156
+ description: 'index of the node (parent node is an array)',
157
+ example: 12
158
+ }]
159
+ },
160
+ exists: {
161
+ type: 'boolean',
162
+ description: 'whether the target path exists',
163
+ example: true
164
+ },
165
+ type: {
166
+ type: 'string',
167
+ enum: ['unknown','object','array','number','boolean','string','date','binary','reference'],
168
+ description: 'data type of the target path',
169
+ example: 'object'
170
+ },
171
+ value: {
172
+ oneOf: [ { type: 'string' }, { type: 'number' }, { type: 'boolean' }, { type: 'array' }, { type: 'object' } ],
173
+ description: `target node's stored value if it is a boolean, number or date, a small string or binary value (less than configured max inline value size), or an empty object or array`,
174
+ example: {}
175
+ },
176
+ address: {
177
+ type: 'object',
178
+ description: 'The physical location of the node in the database',
179
+ required: ['pageNr', 'recordNr'],
180
+ properties: {
181
+ pageNr: { type: 'integer' },
182
+ recordNr: { type: 'integer' }
183
+ }
184
+ },
185
+ children: {
186
+ type: 'object',
187
+ description: `Information about the node's children (if requested)`,
188
+ required: ['more', 'list'],
189
+ properties: {
190
+ count: {
191
+ type: 'integer',
192
+ description: 'The total number of children',
193
+ example: 2865
194
+ },
195
+ more: {
196
+ type: 'boolean',
197
+ description: 'If there are more children than the ones in list',
198
+ example: true
199
+ },
200
+ list: {
201
+ type: 'array',
202
+ description: 'Reflection info about the requested children',
203
+ items: {
204
+ $ref: '#/components/schemas/ReflectionNodeInfo'
205
+ },
206
+ example: [{
207
+ key: 'name',
208
+ type: 'string',
209
+ value: 'My name'
210
+ }]
211
+ }
212
+ }
213
+ }
214
+ },
215
+ example: {
216
+ key: 'jld2cjxh0000qzrmn831i7rn',
217
+ exists: true,
218
+ type: 'object',
219
+ address: { pageNr: 0, recordNr: 234 },
220
+ children: {
221
+ count: 2865,
222
+ more: true,
223
+ list: [{
224
+ key: 'l260qein000009jy3yjig8h9',
225
+ type: 'object',
226
+ address: { pageNr: 1, recordNr: 25 }
227
+ }, {
228
+ key: 'l260rp5b000109jy98ykf7x2',
229
+ type: 'object',
230
+ address: { pageNr: 1, recordNr: 54 }
231
+ }]
232
+ }
233
+ }
234
+ }
235
+ }
236
+ },
237
+ security: [
238
+ // Enable bearer auth globally
239
+ { bearerAuth: [] }
240
+ ],
241
+ },
242
+ apis: [yamlPath]
243
+ };
244
+
245
+ const swaggerDocs = createSwaggerDocs(options);
246
+ env.app.use('/docs', swaggerUi.serve, swaggerUi.setup(swaggerDocs));
247
+ };
248
+
249
+ export default addRoute;
@@ -0,0 +1,80 @@
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+ import { readFileSync } from 'fs';
3
+ import { packageRootPath } from '../shared/rootpath';
4
+ import { join as joinPaths } from 'path';
5
+ import * as os from 'os';
6
+
7
+ export type RequestQuery = null;
8
+ export type RequestBody = null;
9
+ export type ResponseBody = {
10
+ version: string;
11
+ time: number;
12
+ process: number;
13
+ };
14
+ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
15
+
16
+ export const addRoute = (env: RouteInitEnvironment) => {
17
+
18
+ // Read server version from package.json
19
+ const filePath = joinPaths(packageRootPath, '/package.json');
20
+ const json = readFileSync(filePath, 'utf-8');
21
+ const packageInfo = JSON.parse(json);
22
+
23
+ // Add info endpoint
24
+ env.app.get(`/info/${env.db.name}`, (req: Request, res) => {
25
+
26
+ const info = {
27
+ version: packageInfo.version, // Loaded from package.json
28
+ time: Date.now(),
29
+ process: process.pid
30
+ };
31
+ if (req.user && req.user.uid === 'admin') {
32
+ const numberToByteSize = number => {
33
+ return Math.round((number / 1024 / 1024) * 100) / 100 + 'MB';
34
+ }
35
+ const sPerMinute = 60;
36
+ const sPerHour = sPerMinute * 60;
37
+ const sPerDay = sPerHour * 24;
38
+ const numberToTime = number => {
39
+ const days = Math.floor(number / sPerDay);
40
+ number -= sPerDay * days;
41
+ const hours = Math.floor(number / sPerHour);
42
+ number -= hours * sPerHour;
43
+ const minutes = Math.floor(number / sPerMinute);
44
+ number -= minutes * sPerMinute;
45
+ const seconds = Math.floor(number);
46
+ return `${days}d${hours}h${minutes}m${seconds}s`;
47
+ };
48
+ const mem = process.memoryUsage();
49
+ const adminInfo = {
50
+ dbname: env.db.name,
51
+ platform: os.platform(),
52
+ arch: os.arch(),
53
+ release: os.release(),
54
+ host: os.hostname(),
55
+ uptime: numberToTime(os.uptime()),
56
+ load: os.loadavg(),
57
+ mem: {
58
+ total: numberToByteSize(os.totalmem()),
59
+ free: numberToByteSize(os.freemem()),
60
+ process: {
61
+ arrayBuffers: numberToByteSize((mem as any).arrayBuffers), // arrayBuffers was added in Node v13.9.0, v12.17.0
62
+ external: numberToByteSize(mem.external),
63
+ heapTotal: numberToByteSize(mem.heapTotal),
64
+ heapUsed: numberToByteSize(mem.heapUsed),
65
+ residentSet: numberToByteSize(mem.rss)
66
+ }
67
+ },
68
+ cpus: os.cpus(),
69
+ network: os.networkInterfaces()
70
+ }
71
+ Object.assign(info, adminInfo);
72
+ }
73
+ // for (let i = 0; i < 1000000000; i++) {
74
+ // let j = Math.pow(i, 2);
75
+ // }
76
+ res.send(info);
77
+ });
78
+ };
79
+
80
+ export default addRoute;
@@ -0,0 +1,41 @@
1
+ /info/{dbname}:
2
+ get:
3
+ tags:
4
+ - metadata
5
+ summary: Get server info
6
+ description: Returns info about the server, such as version, current date/time and process id. When signed in as the admin user, info about the platform, cpu, memory, and network will also be included
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
+ responses:
16
+ 200:
17
+ description: Returns server information
18
+ content:
19
+ 'application/json':
20
+ schema:
21
+ type: object
22
+ properties:
23
+ version:
24
+ type: string
25
+ example: 1.10.0
26
+ summary: server version number
27
+ time:
28
+ type: number
29
+ example: 868
30
+ summary: unix timestamp (ms since Jan 1, 1970)
31
+ process:
32
+ type: integer
33
+ example: 465
34
+ summary: process number
35
+ 500:
36
+ description: Returns the server error
37
+ content:
38
+ 'text/plain':
39
+ schema:
40
+ type: string
41
+ example: Some error message
@@ -0,0 +1,57 @@
1
+ import { AceBase } from 'acebase';
2
+ import { QueryOperator } from 'acebase-core/dist/types/data-reference';
3
+ import adminOnly from '../middleware/admin-only';
4
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
5
+
6
+ type AceBaseLogLine = {
7
+ action: string;
8
+ ip: string;
9
+ date: string;
10
+ };
11
+
12
+ export type RequestQuery = { take?: string; skip?: string; sort?: 'date'; filter_col?: string; filter_op?: QueryOperator; filter_val?: string };
13
+ export type RequestBody = null;
14
+ export type ResponseBody = AceBaseLogLine[];
15
+ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
16
+
17
+ export const addRoute = (env: RouteInitEnvironment) => {
18
+
19
+ env.app.get(`/logs/${env.db.name}`, adminOnly(env), async (req: Request, res) => {
20
+ // Get database logs
21
+
22
+ // Create indexes if not there yet
23
+ const db = (env.log.ref as any).db as AceBase;
24
+ const createIndexes = [
25
+ db.indexes.create(env.log.ref.path, 'date')
26
+ ];
27
+ if (req.query.filter_col === 'action') {
28
+ createIndexes.push(db.indexes.create(env.log.ref.path, 'action', { include: ['date'] }));
29
+ }
30
+ if (req.query.filter_col === 'code') {
31
+ createIndexes.push(db.indexes.create(env.log.ref.path, 'code', { include: ['date'] }));
32
+ }
33
+ await Promise.all(createIndexes);
34
+
35
+ try {
36
+ const query = env.log.query()
37
+ .take(parseInt(req.query.take ?? '100'))
38
+ .skip(parseInt(req.query.skip ?? '0'))
39
+ .sort(req.query.sort ?? 'date', false);
40
+
41
+ if (req.query.filter_col) {
42
+ query.filter(req.query.filter_col, req.query.filter_op, req.query.filter_val);
43
+ }
44
+
45
+ const snaps = await query.get();
46
+ const logs = snaps.getValues() as AceBaseLogLine[];
47
+ res.send(logs);
48
+ }
49
+ catch (err) {
50
+ res.statusCode = 500;
51
+ res.send(err.message);
52
+ }
53
+ });
54
+
55
+ };
56
+
57
+ export default addRoute;
@@ -0,0 +1,15 @@
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+
3
+ export type RequestQuery = null;
4
+ export type RequestBody = null;
5
+ export type ResponseBody = 'pong';
6
+ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
7
+
8
+ export const addRoute = (env: RouteInitEnvironment) => {
9
+ env.app.get(`/ping/${env.db.name}`, (req: Request, res) => {
10
+ // For simple connectivity check
11
+ res.send('pong');
12
+ });
13
+ };
14
+
15
+ export default addRoute;
@@ -0,0 +1,23 @@
1
+ /ping/{dbname}:
2
+ get:
3
+ tags:
4
+ - metadata
5
+ summary: Ping the server
6
+ description: Ping endpoint to test connectivity with the server. Returns `"pong"`
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
+ responses:
16
+ 200:
17
+ description: Returns the string `"pong"`
18
+ content:
19
+ 'text/plain':
20
+ schema:
21
+ type: string
22
+ value: pong
23
+ example: pong
@@ -0,0 +1,31 @@
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+
3
+ type SimpleAceBaseStorageStats = {
4
+ writes: number;
5
+ reads: number;
6
+ bytesRead: number;
7
+ bytesWritten: number;
8
+ };
9
+
10
+ export type RequestQuery = null;
11
+ export type RequestBody = null;
12
+ export type ResponseBody = SimpleAceBaseStorageStats;
13
+ export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
14
+
15
+ export const addRoute = (env: RouteInitEnvironment) => {
16
+
17
+ env.app.get(`/stats/${env.db.name}`, async (req: Request, res) => {
18
+ // Get database stats
19
+ try {
20
+ const stats = await env.db.api.stats() as SimpleAceBaseStorageStats;
21
+ res.send(stats);
22
+ }
23
+ catch (err) {
24
+ res.statusCode = 500;
25
+ res.send(err.message);
26
+ }
27
+ });
28
+
29
+ };
30
+
31
+ export default addRoute;
@@ -0,0 +1,41 @@
1
+ /stats/{dbname}:
2
+ get:
3
+ tags:
4
+ - metadata
5
+ summary: Get basic database statistics
6
+ description: Returns basic statistics about 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
+ responses:
16
+ 200:
17
+ description: Returns basic database statistics
18
+ content:
19
+ 'application/json':
20
+ schema:
21
+ type: object
22
+ properties:
23
+ writes:
24
+ type: integer
25
+ example: 154
26
+ reads:
27
+ type: integer
28
+ example: 868
29
+ bytesRead:
30
+ type: integer
31
+ example: 78480
32
+ bytesWritten:
33
+ type: integer
34
+ example: 12560
35
+ 500:
36
+ description: Returns the server error
37
+ content:
38
+ 'text/plain':
39
+ schema:
40
+ type: string
41
+ example: Some error message
@@ -0,0 +1,22 @@
1
+ import type { RouteInitEnvironment } from '../shared/env';
2
+ import addInfoRoute from './meta-info';
3
+ import addPingRoute from './meta-ping';
4
+ import addStatsRoute from './meta-stats';
5
+ import addLogsRoute from './meta-logs';
6
+
7
+ export const addRoutes = (env: RouteInitEnvironment) => {
8
+
9
+ // Add info endpoint
10
+ addInfoRoute(env);
11
+
12
+ // Add ping endpoint
13
+ addPingRoute(env);
14
+
15
+ // Add database stats endpoint
16
+ addStatsRoute(env);
17
+
18
+ // Add logs endpoint (admin only)
19
+ addLogsRoute(env);
20
+ };
21
+
22
+ export default addRoutes;