acebase-server 1.11.0 → 1.13.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (342) hide show
  1. package/.vscode/launch.json +24 -0
  2. package/dist/cjs/index.d.ts +1 -0
  3. package/dist/cjs/logger.js +74 -0
  4. package/dist/cjs/middleware/admin-only.js +29 -0
  5. package/dist/cjs/middleware/user.js +4 -4
  6. package/dist/cjs/routes/auth-change-password.js +7 -4
  7. package/dist/cjs/routes/auth-delete.js +9 -7
  8. package/dist/cjs/routes/auth-forgot-password.js +9 -6
  9. package/dist/cjs/routes/auth-reset-password.js +5 -3
  10. package/dist/cjs/routes/auth-signout.js +6 -4
  11. package/dist/cjs/routes/auth-signup.js +17 -15
  12. package/dist/cjs/routes/auth-update.js +9 -6
  13. package/dist/cjs/routes/auth-verify-email.js +6 -3
  14. package/dist/cjs/routes/data-index-create.js +3 -5
  15. package/dist/cjs/routes/data-index-delete.js +2 -4
  16. package/dist/cjs/routes/data-index-list.js +2 -4
  17. package/dist/cjs/routes/data-reflect.js +2 -4
  18. package/dist/cjs/routes/data-schema-get.js +2 -4
  19. package/dist/cjs/routes/data-schema-set.js +2 -4
  20. package/dist/cjs/routes/data-schema-test.js +2 -4
  21. package/dist/cjs/routes/data-schemas-list.js +2 -4
  22. package/dist/cjs/routes/data-set.js +8 -7
  23. package/dist/cjs/routes/data-transaction.js +15 -8
  24. package/dist/cjs/routes/data-update.js +8 -6
  25. package/dist/cjs/routes/meta-logs.js +50 -0
  26. package/dist/cjs/routes/meta.js +3 -0
  27. package/dist/cjs/routes/oauth2-signin.js +9 -6
  28. package/dist/cjs/server.js +3 -1
  29. package/dist/cjs/shared/rootpath.js +2 -0
  30. package/dist/cjs/shared/signin.js +8 -3
  31. package/dist/cjs/start.js +3 -0
  32. package/dist/cjs/websocket/index.js +42 -23
  33. package/dist/esm/index.d.ts +1 -0
  34. package/dist/esm/logger.js +52 -0
  35. package/dist/esm/middleware/admin-only.js +25 -0
  36. package/dist/esm/middleware/user.js +4 -4
  37. package/dist/esm/routes/auth-change-password.js +6 -3
  38. package/dist/esm/routes/auth-delete.js +7 -5
  39. package/dist/esm/routes/auth-forgot-password.js +8 -6
  40. package/dist/esm/routes/auth-reset-password.js +4 -2
  41. package/dist/esm/routes/auth-signout.js +4 -2
  42. package/dist/esm/routes/auth-signup.js +12 -10
  43. package/dist/esm/routes/auth-update.js +8 -6
  44. package/dist/esm/routes/auth-verify-email.js +6 -2
  45. package/dist/esm/routes/data-index-create.js +4 -6
  46. package/dist/esm/routes/data-index-delete.js +3 -5
  47. package/dist/esm/routes/data-index-list.js +3 -5
  48. package/dist/esm/routes/data-reflect.js +1 -4
  49. package/dist/esm/routes/data-schema-get.js +3 -5
  50. package/dist/esm/routes/data-schema-set.js +3 -5
  51. package/dist/esm/routes/data-schema-test.js +3 -5
  52. package/dist/esm/routes/data-schemas-list.js +3 -5
  53. package/dist/esm/routes/data-set.js +6 -5
  54. package/dist/esm/routes/data-transaction.js +12 -5
  55. package/dist/esm/routes/data-update.js +6 -4
  56. package/dist/esm/routes/meta-logs.js +36 -0
  57. package/dist/esm/routes/meta.js +3 -0
  58. package/dist/esm/routes/oauth2-signin.js +8 -5
  59. package/dist/esm/server.js +3 -1
  60. package/dist/esm/shared/rootpath.js +2 -0
  61. package/dist/esm/shared/signin.js +7 -3
  62. package/dist/esm/start.js +3 -0
  63. package/dist/esm/websocket/index.js +37 -22
  64. package/dist/types/logger.d.ts +35 -0
  65. package/dist/types/middleware/admin-only.d.ts +19 -0
  66. package/dist/types/routes/meta-logs.d.ts +20 -0
  67. package/dist/types/rules.d.ts +2 -2
  68. package/dist/types/shared/env.d.ts +3 -1
  69. package/dist/types/shared/signin.d.ts +1 -1
  70. package/dist/types/websocket/index.d.ts +4 -0
  71. package/package.json +5 -5
  72. package/webmanager/acebase-client-browser.min.js +16 -16
  73. package/create-package-files +0 -12
  74. package/dist/cjs/auth.js.map +0 -1
  75. package/dist/cjs/cluster.js.map +0 -1
  76. package/dist/cjs/index.js.map +0 -1
  77. package/dist/cjs/middleware/404.js.map +0 -1
  78. package/dist/cjs/middleware/cache.js.map +0 -1
  79. package/dist/cjs/middleware/connection.js.map +0 -1
  80. package/dist/cjs/middleware/context.js.map +0 -1
  81. package/dist/cjs/middleware/cors.js.map +0 -1
  82. package/dist/cjs/middleware/swagger.js.map +0 -1
  83. package/dist/cjs/middleware/user.js.map +0 -1
  84. package/dist/cjs/oauth-providers/dropbox.js.map +0 -1
  85. package/dist/cjs/oauth-providers/facebook.js.map +0 -1
  86. package/dist/cjs/oauth-providers/google.js.map +0 -1
  87. package/dist/cjs/oauth-providers/index.js.map +0 -1
  88. package/dist/cjs/oauth-providers/instagram.js.map +0 -1
  89. package/dist/cjs/oauth-providers/oauth-provider.js.map +0 -1
  90. package/dist/cjs/oauth-providers/spotify.js.map +0 -1
  91. package/dist/cjs/routes/auth-change-password.js.map +0 -1
  92. package/dist/cjs/routes/auth-delete.js.map +0 -1
  93. package/dist/cjs/routes/auth-forgot-password.js.map +0 -1
  94. package/dist/cjs/routes/auth-reset-password.js.map +0 -1
  95. package/dist/cjs/routes/auth-signin.js.map +0 -1
  96. package/dist/cjs/routes/auth-signout.js.map +0 -1
  97. package/dist/cjs/routes/auth-signup.js.map +0 -1
  98. package/dist/cjs/routes/auth-state.js.map +0 -1
  99. package/dist/cjs/routes/auth-update.js.map +0 -1
  100. package/dist/cjs/routes/auth-verify-email.js.map +0 -1
  101. package/dist/cjs/routes/auth.js.map +0 -1
  102. package/dist/cjs/routes/data-exists.js.map +0 -1
  103. package/dist/cjs/routes/data-export.js.map +0 -1
  104. package/dist/cjs/routes/data-get.js.map +0 -1
  105. package/dist/cjs/routes/data-import.js.map +0 -1
  106. package/dist/cjs/routes/data-index-create.js.map +0 -1
  107. package/dist/cjs/routes/data-index-delete.js.map +0 -1
  108. package/dist/cjs/routes/data-index-list.js.map +0 -1
  109. package/dist/cjs/routes/data-query.js.map +0 -1
  110. package/dist/cjs/routes/data-reflect.js.map +0 -1
  111. package/dist/cjs/routes/data-schema-get.js.map +0 -1
  112. package/dist/cjs/routes/data-schema-set.js.map +0 -1
  113. package/dist/cjs/routes/data-schema-test.js.map +0 -1
  114. package/dist/cjs/routes/data-schemas-list.js.map +0 -1
  115. package/dist/cjs/routes/data-set.js.map +0 -1
  116. package/dist/cjs/routes/data-sync-changes.js.map +0 -1
  117. package/dist/cjs/routes/data-sync-mutations.js.map +0 -1
  118. package/dist/cjs/routes/data-transaction.js.map +0 -1
  119. package/dist/cjs/routes/data-update.js.map +0 -1
  120. package/dist/cjs/routes/data.js.map +0 -1
  121. package/dist/cjs/routes/docs.js.map +0 -1
  122. package/dist/cjs/routes/meta-info.js.map +0 -1
  123. package/dist/cjs/routes/meta-ping.js.map +0 -1
  124. package/dist/cjs/routes/meta-stats.js.map +0 -1
  125. package/dist/cjs/routes/meta.js.map +0 -1
  126. package/dist/cjs/routes/oauth2-init.js.map +0 -1
  127. package/dist/cjs/routes/oauth2-refresh.js.map +0 -1
  128. package/dist/cjs/routes/oauth2-signin.js.map +0 -1
  129. package/dist/cjs/routes/webmanager.js.map +0 -1
  130. package/dist/cjs/rules.js.map +0 -1
  131. package/dist/cjs/schema/user.js.map +0 -1
  132. package/dist/cjs/server.js.map +0 -1
  133. package/dist/cjs/settings/email.js.map +0 -1
  134. package/dist/cjs/settings/index.js.map +0 -1
  135. package/dist/cjs/shared/clients.js.map +0 -1
  136. package/dist/cjs/shared/email.js.map +0 -1
  137. package/dist/cjs/shared/env.js.map +0 -1
  138. package/dist/cjs/shared/error.js.map +0 -1
  139. package/dist/cjs/shared/http.js.map +0 -1
  140. package/dist/cjs/shared/password.js.map +0 -1
  141. package/dist/cjs/shared/rootpath.js.map +0 -1
  142. package/dist/cjs/shared/signin.js.map +0 -1
  143. package/dist/cjs/shared/simple-fetch.js.map +0 -1
  144. package/dist/cjs/shared/tokens.js.map +0 -1
  145. package/dist/cjs/shared/validate.js.map +0 -1
  146. package/dist/cjs/start.js.map +0 -1
  147. package/dist/cjs/test.js.map +0 -1
  148. package/dist/cjs/websocket/index.js.map +0 -1
  149. package/dist/cjs/websocket/manager.js.map +0 -1
  150. package/dist/cjs/websocket/socket.io.js.map +0 -1
  151. package/dist/esm/auth.js.map +0 -1
  152. package/dist/esm/cluster.js.map +0 -1
  153. package/dist/esm/index.js.map +0 -1
  154. package/dist/esm/middleware/404.js.map +0 -1
  155. package/dist/esm/middleware/cache.js.map +0 -1
  156. package/dist/esm/middleware/connection.js.map +0 -1
  157. package/dist/esm/middleware/context.js.map +0 -1
  158. package/dist/esm/middleware/cors.js.map +0 -1
  159. package/dist/esm/middleware/swagger.js.map +0 -1
  160. package/dist/esm/middleware/user.js.map +0 -1
  161. package/dist/esm/oauth-providers/dropbox.js.map +0 -1
  162. package/dist/esm/oauth-providers/facebook.js.map +0 -1
  163. package/dist/esm/oauth-providers/google.js.map +0 -1
  164. package/dist/esm/oauth-providers/index.js.map +0 -1
  165. package/dist/esm/oauth-providers/instagram.js.map +0 -1
  166. package/dist/esm/oauth-providers/oauth-provider.js.map +0 -1
  167. package/dist/esm/oauth-providers/spotify.js.map +0 -1
  168. package/dist/esm/routes/auth-change-password.js.map +0 -1
  169. package/dist/esm/routes/auth-delete.js.map +0 -1
  170. package/dist/esm/routes/auth-forgot-password.js.map +0 -1
  171. package/dist/esm/routes/auth-reset-password.js.map +0 -1
  172. package/dist/esm/routes/auth-signin.js.map +0 -1
  173. package/dist/esm/routes/auth-signout.js.map +0 -1
  174. package/dist/esm/routes/auth-signup.js.map +0 -1
  175. package/dist/esm/routes/auth-state.js.map +0 -1
  176. package/dist/esm/routes/auth-update.js.map +0 -1
  177. package/dist/esm/routes/auth-verify-email.js.map +0 -1
  178. package/dist/esm/routes/auth.js.map +0 -1
  179. package/dist/esm/routes/data-exists.js.map +0 -1
  180. package/dist/esm/routes/data-export.js.map +0 -1
  181. package/dist/esm/routes/data-get.js.map +0 -1
  182. package/dist/esm/routes/data-import.js.map +0 -1
  183. package/dist/esm/routes/data-index-create.js.map +0 -1
  184. package/dist/esm/routes/data-index-delete.js.map +0 -1
  185. package/dist/esm/routes/data-index-list.js.map +0 -1
  186. package/dist/esm/routes/data-query.js.map +0 -1
  187. package/dist/esm/routes/data-reflect.js.map +0 -1
  188. package/dist/esm/routes/data-schema-get.js.map +0 -1
  189. package/dist/esm/routes/data-schema-set.js.map +0 -1
  190. package/dist/esm/routes/data-schema-test.js.map +0 -1
  191. package/dist/esm/routes/data-schemas-list.js.map +0 -1
  192. package/dist/esm/routes/data-set.js.map +0 -1
  193. package/dist/esm/routes/data-sync-changes.js.map +0 -1
  194. package/dist/esm/routes/data-sync-mutations.js.map +0 -1
  195. package/dist/esm/routes/data-transaction.js.map +0 -1
  196. package/dist/esm/routes/data-update.js.map +0 -1
  197. package/dist/esm/routes/data.js.map +0 -1
  198. package/dist/esm/routes/docs.js.map +0 -1
  199. package/dist/esm/routes/meta-info.js.map +0 -1
  200. package/dist/esm/routes/meta-ping.js.map +0 -1
  201. package/dist/esm/routes/meta-stats.js.map +0 -1
  202. package/dist/esm/routes/meta.js.map +0 -1
  203. package/dist/esm/routes/oauth2-init.js.map +0 -1
  204. package/dist/esm/routes/oauth2-refresh.js.map +0 -1
  205. package/dist/esm/routes/oauth2-signin.js.map +0 -1
  206. package/dist/esm/routes/webmanager.js.map +0 -1
  207. package/dist/esm/rules.js.map +0 -1
  208. package/dist/esm/schema/user.js.map +0 -1
  209. package/dist/esm/server.js.map +0 -1
  210. package/dist/esm/settings/email.js.map +0 -1
  211. package/dist/esm/settings/index.js.map +0 -1
  212. package/dist/esm/shared/clients.js.map +0 -1
  213. package/dist/esm/shared/email.js.map +0 -1
  214. package/dist/esm/shared/env.js.map +0 -1
  215. package/dist/esm/shared/error.js.map +0 -1
  216. package/dist/esm/shared/http.js.map +0 -1
  217. package/dist/esm/shared/password.js.map +0 -1
  218. package/dist/esm/shared/rootpath.js.map +0 -1
  219. package/dist/esm/shared/signin.js.map +0 -1
  220. package/dist/esm/shared/simple-fetch.js.map +0 -1
  221. package/dist/esm/shared/tokens.js.map +0 -1
  222. package/dist/esm/shared/validate.js.map +0 -1
  223. package/dist/esm/start.js.map +0 -1
  224. package/dist/esm/test.js.map +0 -1
  225. package/dist/esm/websocket/index.js.map +0 -1
  226. package/dist/esm/websocket/manager.js.map +0 -1
  227. package/dist/esm/websocket/socket.io.js.map +0 -1
  228. package/src/auth.ts +0 -87
  229. package/src/cluster.ts +0 -62
  230. package/src/index.ts +0 -4
  231. package/src/middleware/404.ts +0 -13
  232. package/src/middleware/cache.ts +0 -15
  233. package/src/middleware/connection.ts +0 -48
  234. package/src/middleware/context.ts +0 -23
  235. package/src/middleware/cors.ts +0 -49
  236. package/src/middleware/swagger.ts +0 -19
  237. package/src/middleware/user.ts +0 -51
  238. package/src/oauth-providers/dropbox.ts +0 -144
  239. package/src/oauth-providers/facebook.ts +0 -103
  240. package/src/oauth-providers/google.ts +0 -147
  241. package/src/oauth-providers/index.ts +0 -21
  242. package/src/oauth-providers/instagram.ts +0 -98
  243. package/src/oauth-providers/oauth-provider.ts +0 -65
  244. package/src/oauth-providers/spotify.ts +0 -127
  245. package/src/placeholder.d.ts +0 -12
  246. package/src/routes/auth-change-password.ts +0 -89
  247. package/src/routes/auth-change-password.yaml +0 -74
  248. package/src/routes/auth-delete.ts +0 -47
  249. package/src/routes/auth-delete.yaml +0 -78
  250. package/src/routes/auth-forgot-password.ts +0 -73
  251. package/src/routes/auth-forgot-password.yaml +0 -50
  252. package/src/routes/auth-reset-password.ts +0 -93
  253. package/src/routes/auth-reset-password.yaml +0 -54
  254. package/src/routes/auth-signin.ts +0 -55
  255. package/src/routes/auth-signin.yaml +0 -130
  256. package/src/routes/auth-signout.ts +0 -61
  257. package/src/routes/auth-signout.yaml +0 -46
  258. package/src/routes/auth-signup.ts +0 -161
  259. package/src/routes/auth-signup.yaml +0 -136
  260. package/src/routes/auth-state.ts +0 -20
  261. package/src/routes/auth-state.yaml +0 -29
  262. package/src/routes/auth-update.ts +0 -147
  263. package/src/routes/auth-update.yaml +0 -152
  264. package/src/routes/auth-verify-email.ts +0 -67
  265. package/src/routes/auth-verify-email.yaml +0 -53
  266. package/src/routes/auth.ts +0 -67
  267. package/src/routes/data-exists.ts +0 -31
  268. package/src/routes/data-exists.yaml +0 -44
  269. package/src/routes/data-export.ts +0 -51
  270. package/src/routes/data-export.yaml +0 -64
  271. package/src/routes/data-get.ts +0 -68
  272. package/src/routes/data-get.yaml +0 -54
  273. package/src/routes/data-import.ts +0 -56
  274. package/src/routes/data-import.yaml +0 -75
  275. package/src/routes/data-index-create.ts +0 -85
  276. package/src/routes/data-index-create.yaml +0 -105
  277. package/src/routes/data-index-delete.ts +0 -39
  278. package/src/routes/data-index-delete.yaml +0 -51
  279. package/src/routes/data-index-list.ts +0 -42
  280. package/src/routes/data-index-list.yaml +0 -80
  281. package/src/routes/data-query.ts +0 -97
  282. package/src/routes/data-query.yaml +0 -166
  283. package/src/routes/data-reflect.ts +0 -94
  284. package/src/routes/data-reflect.yaml +0 -124
  285. package/src/routes/data-schema-get.ts +0 -38
  286. package/src/routes/data-schema-get.yaml +0 -53
  287. package/src/routes/data-schema-set.ts +0 -38
  288. package/src/routes/data-schema-set.yaml +0 -60
  289. package/src/routes/data-schema-test.ts +0 -53
  290. package/src/routes/data-schema-test.yaml +0 -66
  291. package/src/routes/data-schemas-list.ts +0 -33
  292. package/src/routes/data-schemas-list.yaml +0 -41
  293. package/src/routes/data-set.ts +0 -80
  294. package/src/routes/data-set.yaml +0 -77
  295. package/src/routes/data-sync-changes.ts +0 -78
  296. package/src/routes/data-sync-changes.yaml +0 -67
  297. package/src/routes/data-sync-mutations.ts +0 -78
  298. package/src/routes/data-sync-mutations.yaml +0 -67
  299. package/src/routes/data-transaction-finish.yaml +0 -82
  300. package/src/routes/data-transaction-start.yaml +0 -58
  301. package/src/routes/data-transaction.ts +0 -159
  302. package/src/routes/data-update.ts +0 -81
  303. package/src/routes/data-update.yaml +0 -77
  304. package/src/routes/data.ts +0 -79
  305. package/src/routes/docs.ts +0 -249
  306. package/src/routes/meta-info.ts +0 -80
  307. package/src/routes/meta-info.yaml +0 -41
  308. package/src/routes/meta-ping.ts +0 -15
  309. package/src/routes/meta-ping.yaml +0 -23
  310. package/src/routes/meta-stats.ts +0 -31
  311. package/src/routes/meta-stats.yaml +0 -41
  312. package/src/routes/meta.ts +0 -18
  313. package/src/routes/oauth2-init.ts +0 -44
  314. package/src/routes/oauth2-init.yaml +0 -63
  315. package/src/routes/oauth2-refresh.ts +0 -39
  316. package/src/routes/oauth2-refresh.yaml +0 -65
  317. package/src/routes/oauth2-signin.ts +0 -282
  318. package/src/routes/oauth2-signin.yaml +0 -66
  319. package/src/routes/webmanager.ts +0 -29
  320. package/src/rules.ts +0 -196
  321. package/src/schema/user.ts +0 -99
  322. package/src/server.ts +0 -418
  323. package/src/settings/email.ts +0 -18
  324. package/src/settings/index.ts +0 -241
  325. package/src/shared/clients.ts +0 -31
  326. package/src/shared/email.ts +0 -33
  327. package/src/shared/env.ts +0 -38
  328. package/src/shared/error.ts +0 -37
  329. package/src/shared/http.ts +0 -26
  330. package/src/shared/password.ts +0 -41
  331. package/src/shared/rootpath.ts +0 -15
  332. package/src/shared/signin.ts +0 -143
  333. package/src/shared/simple-fetch.ts +0 -65
  334. package/src/shared/tokens.ts +0 -77
  335. package/src/shared/validate.ts +0 -53
  336. package/src/start.ts +0 -45
  337. package/src/test.ts +0 -10
  338. package/src/websocket/index.ts +0 -320
  339. package/src/websocket/manager.ts +0 -46
  340. package/src/websocket/socket.io.ts +0 -90
  341. package/tsconfig-cjs.json +0 -10
  342. package/tsconfig.json +0 -21
@@ -1,249 +0,0 @@
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;
@@ -1,80 +0,0 @@
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;
@@ -1,41 +0,0 @@
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
@@ -1,15 +0,0 @@
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;
@@ -1,23 +0,0 @@
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
@@ -1,31 +0,0 @@
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;
@@ -1,41 +0,0 @@
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
@@ -1,18 +0,0 @@
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
-
6
- export const addRoutes = (env: RouteInitEnvironment) => {
7
-
8
- // Add info endpoint
9
- addInfoRoute(env);
10
-
11
- // Add ping endpoint
12
- addPingRoute(env);
13
-
14
- // Add database stats endpoint
15
- addStatsRoute(env);
16
- };
17
-
18
- export default addRoutes;
@@ -1,44 +0,0 @@
1
- import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
- import { createSignedPublicToken } from '../shared/tokens';
3
-
4
- export type RequestQuery = { provider: string; callbackUrl: string; [option_name: string]: string };
5
- export type RequestBody = null;
6
- export type ResponseBody = { redirectUrl: string };
7
- export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
8
-
9
- export const addRoute = (env: RouteInitEnvironment) => {
10
- env.app.get(`/oauth2/${env.db.name}/init`, async (req: Request, res) => {
11
-
12
- try {
13
- const providerName = req.query.provider;
14
- const callbackUrl = req.query.callbackUrl;
15
- const options = Object.keys(req.query).filter(key => key.startsWith('option_')).reduce((options, key) => {
16
- const name = key.slice(7);
17
- let value:string|number|boolean = req.query[key];
18
- if (['true','false'].includes(value)) { value = value === 'true'; }
19
- else if (/^\-?[0-9]+$/.test(value)) { value = parseInt(value); }
20
- options[name] = value;
21
- return options;
22
- }, {});
23
- const signedInUid = req.user && req.user.uid;
24
- const provider = env.authProviders[providerName];
25
- if (!provider) {
26
- throw new Error(`Provider ${providerName} is not available, or not properly configured by the db admin`);
27
- }
28
- // Create secure state so it cannot be tampered with. hash it with a server-only known salt: the generated admin password salt
29
- if (!env.tokenSalt) {
30
- // Server is not ready yet. Used to do `await this.ready();` on the server instance, maybe do that again later
31
- throw new Error(`Server not ready yet`);
32
- }
33
- const state = createSignedPublicToken({ flow: 'redirect', provider: providerName, uid: signedInUid, callbackUrl }, env.tokenSalt);
34
- const clientAuthUrl = await provider.init({ redirect_url: `${req.protocol}://${req.headers.host}/oauth2/${env.db.name}/signin`, state, options });
35
- res.send({ redirectUrl: clientAuthUrl });
36
- }
37
- catch(err) {
38
- res.status(500).send(err.message);
39
- }
40
-
41
- });
42
- };
43
-
44
- export default addRoute;
@@ -1,63 +0,0 @@
1
- /oauth2/{dbname}/init:
2
- get:
3
- tags:
4
- - auth
5
- - oauth2
6
- summary: Starts an OAuth2 flow
7
- description: Starts a 3rd party OAuth2 authentication flow. This allows a user to sign in (and sign up) using an external auth provider such as Facebook, Google etc. The client app has to call this endpoint to get an url to redirect the user to kick off the OAuth2 flow. If the client is already authenticated, the external account will be linked to the existing user. The provider used must have been added to the server configuration with `server.configAuthProvider(provider, config)`. In the Javascript client, this OAuth2 flow can be kicked off with `client.auth.startAuthProviderSignIn(provider, callbackUrl, options)` or (browser only) `client.auth.signInWithRedirect(provider)` which uses the current url as `callbackUrl`.
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: provider
17
- in: query
18
- description: External OAuth2 provider name
19
- required: true
20
- schema:
21
- type: string
22
- example: facebook
23
- - name: callbackUrl
24
- in: query
25
- description: The url to redirect the user to after they successfully authenticated, or canceled. If the signin is successful, this url is called with a `result` query parameter (eg `https://my.website.com/oauth2/callback?result=eufy3f73gfvjbwe314f...`) that can be used by the AceBase client to finish the OAuth2 flow with `client.auth.finishAuthProviderSignIn(result)`, or `client.auth.getRedirectResult()`. If the signin fails, this url will be called with query parameters `provider`, `error`, and optionally an additional `reason` and `description`, eg `https://my.website.com/oauth2/callback?error=canceled&reason=user_canceled&description=The+user+canceled+the+auth+request`
26
- required: true
27
- schema:
28
- type: string
29
- format: url
30
- example: https://my.website.com/oauth2/callback
31
- - name: option_[name]
32
- in: query
33
- description: Additional option to pass to the auth provider. For example `force_reauthentication` can be set for Dropbox by setting `option_force_reauthentication` to `true`
34
- required: false
35
- schema:
36
- type: string
37
- example: true
38
- - name: option_force_reauthentication
39
- in: query
40
- required: false
41
- description: Example option, triggers Dropbox to force the user to sign in instead of using the currently signed in user
42
- schema:
43
- type: string
44
- example: true
45
- responses:
46
- 200:
47
- description: Returns a JSON object containing the redirectUrl to send the end user to
48
- content:
49
- 'application/json':
50
- schema:
51
- type: object
52
- properties:
53
- redirectUrl:
54
- type: string
55
- example:
56
- redirectUrl: https://www.facebook.com/v7.0/dialog/oauth?response_type=code&client_id=[configured facebook client id]&scope=[configured scopes]&redirect_uri=[url set by AceBase]&state=[state set by AceBase]}
57
- 500:
58
- description: If anything goes wrong on the server, it returns the actual error text in plain text
59
- content:
60
- 'text/plain':
61
- schema:
62
- type: string
63
- example: Some error text
@@ -1,39 +0,0 @@
1
- import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
-
3
- export type RequestQuery = { provider: string; refresh_token: string };
4
- export type RequestBody = null;
5
- export type ResponseBody = { provider: { name: string; access_token: string; refresh_token: string; expires_in: number } };
6
- export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
7
-
8
- export const addRoute = (env: RouteInitEnvironment) => {
9
- env.app.get(`/oauth2/${env.db.name}/refresh`, async (req: Request, res) => {
10
-
11
- try {
12
- const providerName = req.query.provider;
13
- const refreshToken = req.query.refresh_token;
14
- const provider = env.authProviders[providerName];
15
- if (!provider) {
16
- throw new Error(`Provider ${provider} is not available, or not properly configured by the db admin`);
17
- }
18
- if (!refreshToken) {
19
- throw new Error(`No refresh_token passed`);
20
- }
21
- // Get new access & refresh tokens
22
- const tokens = await provider.getAccessToken({ type: 'refresh', refresh_token: refreshToken });
23
- res.send({
24
- provider: {
25
- name: providerName,
26
- access_token: tokens.access_token,
27
- refresh_token: tokens.refresh_token,
28
- expires_in: tokens.expires_in
29
- }
30
- });
31
- }
32
- catch(err) {
33
- res.status(500).send(err.message);
34
- }
35
-
36
- });
37
- };
38
-
39
- export default addRoute;