acebase-server 1.12.0 → 1.13.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 (286) hide show
  1. package/.vscode/launch.json +24 -0
  2. package/dist/cjs/index.d.ts +1 -0
  3. package/dist/cjs/shared/rootpath.js +2 -0
  4. package/dist/esm/index.d.ts +1 -0
  5. package/dist/esm/shared/rootpath.js +2 -0
  6. package/package.json +3 -3
  7. package/webmanager/acebase-client-browser.min.js +16 -16
  8. package/create-package-files +0 -12
  9. package/dist/cjs/auth.js.map +0 -1
  10. package/dist/cjs/cluster.js.map +0 -1
  11. package/dist/cjs/index.js.map +0 -1
  12. package/dist/cjs/logger.js.map +0 -1
  13. package/dist/cjs/middleware/404.js.map +0 -1
  14. package/dist/cjs/middleware/admin-only.js.map +0 -1
  15. package/dist/cjs/middleware/cache.js.map +0 -1
  16. package/dist/cjs/middleware/connection.js.map +0 -1
  17. package/dist/cjs/middleware/context.js.map +0 -1
  18. package/dist/cjs/middleware/cors.js.map +0 -1
  19. package/dist/cjs/middleware/swagger.js.map +0 -1
  20. package/dist/cjs/middleware/user.js.map +0 -1
  21. package/dist/cjs/oauth-providers/dropbox.js.map +0 -1
  22. package/dist/cjs/oauth-providers/facebook.js.map +0 -1
  23. package/dist/cjs/oauth-providers/google.js.map +0 -1
  24. package/dist/cjs/oauth-providers/index.js.map +0 -1
  25. package/dist/cjs/oauth-providers/instagram.js.map +0 -1
  26. package/dist/cjs/oauth-providers/oauth-provider.js.map +0 -1
  27. package/dist/cjs/oauth-providers/spotify.js.map +0 -1
  28. package/dist/cjs/routes/auth-change-password.js.map +0 -1
  29. package/dist/cjs/routes/auth-delete.js.map +0 -1
  30. package/dist/cjs/routes/auth-forgot-password.js.map +0 -1
  31. package/dist/cjs/routes/auth-reset-password.js.map +0 -1
  32. package/dist/cjs/routes/auth-signin.js.map +0 -1
  33. package/dist/cjs/routes/auth-signout.js.map +0 -1
  34. package/dist/cjs/routes/auth-signup.js.map +0 -1
  35. package/dist/cjs/routes/auth-state.js.map +0 -1
  36. package/dist/cjs/routes/auth-update.js.map +0 -1
  37. package/dist/cjs/routes/auth-verify-email.js.map +0 -1
  38. package/dist/cjs/routes/auth.js.map +0 -1
  39. package/dist/cjs/routes/data-exists.js.map +0 -1
  40. package/dist/cjs/routes/data-export.js.map +0 -1
  41. package/dist/cjs/routes/data-get.js.map +0 -1
  42. package/dist/cjs/routes/data-import.js.map +0 -1
  43. package/dist/cjs/routes/data-index-create.js.map +0 -1
  44. package/dist/cjs/routes/data-index-delete.js.map +0 -1
  45. package/dist/cjs/routes/data-index-list.js.map +0 -1
  46. package/dist/cjs/routes/data-query.js.map +0 -1
  47. package/dist/cjs/routes/data-reflect.js.map +0 -1
  48. package/dist/cjs/routes/data-schema-get.js.map +0 -1
  49. package/dist/cjs/routes/data-schema-set.js.map +0 -1
  50. package/dist/cjs/routes/data-schema-test.js.map +0 -1
  51. package/dist/cjs/routes/data-schemas-list.js.map +0 -1
  52. package/dist/cjs/routes/data-set.js.map +0 -1
  53. package/dist/cjs/routes/data-sync-changes.js.map +0 -1
  54. package/dist/cjs/routes/data-sync-mutations.js.map +0 -1
  55. package/dist/cjs/routes/data-transaction.js.map +0 -1
  56. package/dist/cjs/routes/data-update.js.map +0 -1
  57. package/dist/cjs/routes/data.js.map +0 -1
  58. package/dist/cjs/routes/docs.js.map +0 -1
  59. package/dist/cjs/routes/meta-info.js.map +0 -1
  60. package/dist/cjs/routes/meta-logs.js.map +0 -1
  61. package/dist/cjs/routes/meta-ping.js.map +0 -1
  62. package/dist/cjs/routes/meta-stats.js.map +0 -1
  63. package/dist/cjs/routes/meta.js.map +0 -1
  64. package/dist/cjs/routes/oauth2-init.js.map +0 -1
  65. package/dist/cjs/routes/oauth2-refresh.js.map +0 -1
  66. package/dist/cjs/routes/oauth2-signin.js.map +0 -1
  67. package/dist/cjs/routes/webmanager.js.map +0 -1
  68. package/dist/cjs/rules.js.map +0 -1
  69. package/dist/cjs/schema/user.js.map +0 -1
  70. package/dist/cjs/server.js.map +0 -1
  71. package/dist/cjs/settings/email.js.map +0 -1
  72. package/dist/cjs/settings/index.js.map +0 -1
  73. package/dist/cjs/shared/clients.js.map +0 -1
  74. package/dist/cjs/shared/email.js.map +0 -1
  75. package/dist/cjs/shared/env.js.map +0 -1
  76. package/dist/cjs/shared/error.js.map +0 -1
  77. package/dist/cjs/shared/http.js.map +0 -1
  78. package/dist/cjs/shared/password.js.map +0 -1
  79. package/dist/cjs/shared/rootpath.js.map +0 -1
  80. package/dist/cjs/shared/signin.js.map +0 -1
  81. package/dist/cjs/shared/simple-fetch.js.map +0 -1
  82. package/dist/cjs/shared/tokens.js.map +0 -1
  83. package/dist/cjs/shared/validate.js.map +0 -1
  84. package/dist/cjs/start.js.map +0 -1
  85. package/dist/cjs/test.js.map +0 -1
  86. package/dist/cjs/websocket/index.js.map +0 -1
  87. package/dist/cjs/websocket/manager.js.map +0 -1
  88. package/dist/cjs/websocket/socket.io.js.map +0 -1
  89. package/dist/esm/auth.js.map +0 -1
  90. package/dist/esm/cluster.js.map +0 -1
  91. package/dist/esm/index.js.map +0 -1
  92. package/dist/esm/logger.js.map +0 -1
  93. package/dist/esm/middleware/404.js.map +0 -1
  94. package/dist/esm/middleware/admin-only.js.map +0 -1
  95. package/dist/esm/middleware/cache.js.map +0 -1
  96. package/dist/esm/middleware/connection.js.map +0 -1
  97. package/dist/esm/middleware/context.js.map +0 -1
  98. package/dist/esm/middleware/cors.js.map +0 -1
  99. package/dist/esm/middleware/swagger.js.map +0 -1
  100. package/dist/esm/middleware/user.js.map +0 -1
  101. package/dist/esm/oauth-providers/dropbox.js.map +0 -1
  102. package/dist/esm/oauth-providers/facebook.js.map +0 -1
  103. package/dist/esm/oauth-providers/google.js.map +0 -1
  104. package/dist/esm/oauth-providers/index.js.map +0 -1
  105. package/dist/esm/oauth-providers/instagram.js.map +0 -1
  106. package/dist/esm/oauth-providers/oauth-provider.js.map +0 -1
  107. package/dist/esm/oauth-providers/spotify.js.map +0 -1
  108. package/dist/esm/routes/auth-change-password.js.map +0 -1
  109. package/dist/esm/routes/auth-delete.js.map +0 -1
  110. package/dist/esm/routes/auth-forgot-password.js.map +0 -1
  111. package/dist/esm/routes/auth-reset-password.js.map +0 -1
  112. package/dist/esm/routes/auth-signin.js.map +0 -1
  113. package/dist/esm/routes/auth-signout.js.map +0 -1
  114. package/dist/esm/routes/auth-signup.js.map +0 -1
  115. package/dist/esm/routes/auth-state.js.map +0 -1
  116. package/dist/esm/routes/auth-update.js.map +0 -1
  117. package/dist/esm/routes/auth-verify-email.js.map +0 -1
  118. package/dist/esm/routes/auth.js.map +0 -1
  119. package/dist/esm/routes/data-exists.js.map +0 -1
  120. package/dist/esm/routes/data-export.js.map +0 -1
  121. package/dist/esm/routes/data-get.js.map +0 -1
  122. package/dist/esm/routes/data-import.js.map +0 -1
  123. package/dist/esm/routes/data-index-create.js.map +0 -1
  124. package/dist/esm/routes/data-index-delete.js.map +0 -1
  125. package/dist/esm/routes/data-index-list.js.map +0 -1
  126. package/dist/esm/routes/data-query.js.map +0 -1
  127. package/dist/esm/routes/data-reflect.js.map +0 -1
  128. package/dist/esm/routes/data-schema-get.js.map +0 -1
  129. package/dist/esm/routes/data-schema-set.js.map +0 -1
  130. package/dist/esm/routes/data-schema-test.js.map +0 -1
  131. package/dist/esm/routes/data-schemas-list.js.map +0 -1
  132. package/dist/esm/routes/data-set.js.map +0 -1
  133. package/dist/esm/routes/data-sync-changes.js.map +0 -1
  134. package/dist/esm/routes/data-sync-mutations.js.map +0 -1
  135. package/dist/esm/routes/data-transaction.js.map +0 -1
  136. package/dist/esm/routes/data-update.js.map +0 -1
  137. package/dist/esm/routes/data.js.map +0 -1
  138. package/dist/esm/routes/docs.js.map +0 -1
  139. package/dist/esm/routes/meta-info.js.map +0 -1
  140. package/dist/esm/routes/meta-logs.js.map +0 -1
  141. package/dist/esm/routes/meta-ping.js.map +0 -1
  142. package/dist/esm/routes/meta-stats.js.map +0 -1
  143. package/dist/esm/routes/meta.js.map +0 -1
  144. package/dist/esm/routes/oauth2-init.js.map +0 -1
  145. package/dist/esm/routes/oauth2-refresh.js.map +0 -1
  146. package/dist/esm/routes/oauth2-signin.js.map +0 -1
  147. package/dist/esm/routes/webmanager.js.map +0 -1
  148. package/dist/esm/rules.js.map +0 -1
  149. package/dist/esm/schema/user.js.map +0 -1
  150. package/dist/esm/server.js.map +0 -1
  151. package/dist/esm/settings/email.js.map +0 -1
  152. package/dist/esm/settings/index.js.map +0 -1
  153. package/dist/esm/shared/clients.js.map +0 -1
  154. package/dist/esm/shared/email.js.map +0 -1
  155. package/dist/esm/shared/env.js.map +0 -1
  156. package/dist/esm/shared/error.js.map +0 -1
  157. package/dist/esm/shared/http.js.map +0 -1
  158. package/dist/esm/shared/password.js.map +0 -1
  159. package/dist/esm/shared/rootpath.js.map +0 -1
  160. package/dist/esm/shared/signin.js.map +0 -1
  161. package/dist/esm/shared/simple-fetch.js.map +0 -1
  162. package/dist/esm/shared/tokens.js.map +0 -1
  163. package/dist/esm/shared/validate.js.map +0 -1
  164. package/dist/esm/start.js.map +0 -1
  165. package/dist/esm/test.js.map +0 -1
  166. package/dist/esm/websocket/index.js.map +0 -1
  167. package/dist/esm/websocket/manager.js.map +0 -1
  168. package/dist/esm/websocket/socket.io.js.map +0 -1
  169. package/src/auth.ts +0 -87
  170. package/src/cluster.ts +0 -62
  171. package/src/index.ts +0 -4
  172. package/src/logger.ts +0 -56
  173. package/src/middleware/404.ts +0 -13
  174. package/src/middleware/admin-only.ts +0 -29
  175. package/src/middleware/cache.ts +0 -15
  176. package/src/middleware/connection.ts +0 -48
  177. package/src/middleware/context.ts +0 -23
  178. package/src/middleware/cors.ts +0 -49
  179. package/src/middleware/swagger.ts +0 -19
  180. package/src/middleware/user.ts +0 -51
  181. package/src/oauth-providers/dropbox.ts +0 -144
  182. package/src/oauth-providers/facebook.ts +0 -103
  183. package/src/oauth-providers/google.ts +0 -147
  184. package/src/oauth-providers/index.ts +0 -21
  185. package/src/oauth-providers/instagram.ts +0 -98
  186. package/src/oauth-providers/oauth-provider.ts +0 -65
  187. package/src/oauth-providers/spotify.ts +0 -127
  188. package/src/placeholder.d.ts +0 -12
  189. package/src/routes/auth-change-password.ts +0 -92
  190. package/src/routes/auth-change-password.yaml +0 -74
  191. package/src/routes/auth-delete.ts +0 -49
  192. package/src/routes/auth-delete.yaml +0 -78
  193. package/src/routes/auth-forgot-password.ts +0 -77
  194. package/src/routes/auth-forgot-password.yaml +0 -50
  195. package/src/routes/auth-reset-password.ts +0 -96
  196. package/src/routes/auth-reset-password.yaml +0 -54
  197. package/src/routes/auth-signin.ts +0 -55
  198. package/src/routes/auth-signin.yaml +0 -130
  199. package/src/routes/auth-signout.ts +0 -64
  200. package/src/routes/auth-signout.yaml +0 -46
  201. package/src/routes/auth-signup.ts +0 -164
  202. package/src/routes/auth-signup.yaml +0 -136
  203. package/src/routes/auth-state.ts +0 -20
  204. package/src/routes/auth-state.yaml +0 -29
  205. package/src/routes/auth-update.ts +0 -149
  206. package/src/routes/auth-update.yaml +0 -152
  207. package/src/routes/auth-verify-email.ts +0 -75
  208. package/src/routes/auth-verify-email.yaml +0 -53
  209. package/src/routes/auth.ts +0 -67
  210. package/src/routes/data-exists.ts +0 -31
  211. package/src/routes/data-exists.yaml +0 -44
  212. package/src/routes/data-export.ts +0 -51
  213. package/src/routes/data-export.yaml +0 -64
  214. package/src/routes/data-get.ts +0 -68
  215. package/src/routes/data-get.yaml +0 -54
  216. package/src/routes/data-import.ts +0 -56
  217. package/src/routes/data-import.yaml +0 -75
  218. package/src/routes/data-index-create.ts +0 -82
  219. package/src/routes/data-index-create.yaml +0 -105
  220. package/src/routes/data-index-delete.ts +0 -36
  221. package/src/routes/data-index-delete.yaml +0 -51
  222. package/src/routes/data-index-list.ts +0 -39
  223. package/src/routes/data-index-list.yaml +0 -80
  224. package/src/routes/data-query.ts +0 -97
  225. package/src/routes/data-query.yaml +0 -166
  226. package/src/routes/data-reflect.ts +0 -91
  227. package/src/routes/data-reflect.yaml +0 -124
  228. package/src/routes/data-schema-get.ts +0 -36
  229. package/src/routes/data-schema-get.yaml +0 -53
  230. package/src/routes/data-schema-set.ts +0 -35
  231. package/src/routes/data-schema-set.yaml +0 -60
  232. package/src/routes/data-schema-test.ts +0 -50
  233. package/src/routes/data-schema-test.yaml +0 -66
  234. package/src/routes/data-schemas-list.ts +0 -31
  235. package/src/routes/data-schemas-list.yaml +0 -41
  236. package/src/routes/data-set.ts +0 -84
  237. package/src/routes/data-set.yaml +0 -77
  238. package/src/routes/data-sync-changes.ts +0 -78
  239. package/src/routes/data-sync-changes.yaml +0 -67
  240. package/src/routes/data-sync-mutations.ts +0 -78
  241. package/src/routes/data-sync-mutations.yaml +0 -67
  242. package/src/routes/data-transaction-finish.yaml +0 -82
  243. package/src/routes/data-transaction-start.yaml +0 -58
  244. package/src/routes/data-transaction.ts +0 -168
  245. package/src/routes/data-update.ts +0 -85
  246. package/src/routes/data-update.yaml +0 -77
  247. package/src/routes/data.ts +0 -79
  248. package/src/routes/docs.ts +0 -249
  249. package/src/routes/meta-info.ts +0 -80
  250. package/src/routes/meta-info.yaml +0 -41
  251. package/src/routes/meta-logs.ts +0 -57
  252. package/src/routes/meta-ping.ts +0 -15
  253. package/src/routes/meta-ping.yaml +0 -23
  254. package/src/routes/meta-stats.ts +0 -31
  255. package/src/routes/meta-stats.yaml +0 -41
  256. package/src/routes/meta.ts +0 -22
  257. package/src/routes/oauth2-init.ts +0 -44
  258. package/src/routes/oauth2-init.yaml +0 -63
  259. package/src/routes/oauth2-refresh.ts +0 -39
  260. package/src/routes/oauth2-refresh.yaml +0 -65
  261. package/src/routes/oauth2-signin.ts +0 -286
  262. package/src/routes/oauth2-signin.yaml +0 -66
  263. package/src/routes/webmanager.ts +0 -29
  264. package/src/rules.ts +0 -196
  265. package/src/schema/user.ts +0 -99
  266. package/src/server.ts +0 -420
  267. package/src/settings/email.ts +0 -18
  268. package/src/settings/index.ts +0 -241
  269. package/src/shared/clients.ts +0 -31
  270. package/src/shared/email.ts +0 -33
  271. package/src/shared/env.ts +0 -39
  272. package/src/shared/error.ts +0 -37
  273. package/src/shared/http.ts +0 -26
  274. package/src/shared/password.ts +0 -41
  275. package/src/shared/rootpath.ts +0 -15
  276. package/src/shared/signin.ts +0 -149
  277. package/src/shared/simple-fetch.ts +0 -65
  278. package/src/shared/tokens.ts +0 -77
  279. package/src/shared/validate.ts +0 -53
  280. package/src/start.ts +0 -48
  281. package/src/test.ts +0 -10
  282. package/src/websocket/index.ts +0 -337
  283. package/src/websocket/manager.ts +0 -46
  284. package/src/websocket/socket.io.ts +0 -90
  285. package/tsconfig-cjs.json +0 -10
  286. package/tsconfig.json +0 -21
package/src/server.ts DELETED
@@ -1,420 +0,0 @@
1
- import { ColorStyle, DebugLogger, SimpleEventEmitter } from 'acebase-core';
2
- import { AceBaseServerSettings, AceBaseServerConfig } from './settings';
3
- import { createApp, HttpRequest, HttpResponse } from './shared/http';
4
- import { addWebsocketServer } from './websocket';
5
- import { RouteInitEnvironment } from './shared/env';
6
- import { ConnectedClient } from './shared/clients';
7
- import { AceBase, AceBaseLocalSettings, AceBaseStorageSettings } from 'acebase';
8
- import { createServer } from 'http';
9
- import { createServer as createSecureServer } from 'https';
10
- import { OAuth2Provider } from './oauth-providers/oauth-provider';
11
- import oAuth2Providers from './oauth-providers';
12
- import { PathBasedRules } from './rules';
13
- import { DbUserAccountDetails } from './schema/user';
14
- import { Api } from 'acebase-core/src/api';
15
- import addConnectionMiddleware from './middleware/connection';
16
- import addCorsMiddleware from './middleware/cors';
17
- import addAuthenticionRoutes from './routes/auth';
18
- import setupAuthentication from './auth';
19
- import addDataRoutes from './routes/data';
20
- import addDocsRoute from './routes/docs';
21
- import addWebManagerRoutes from './routes/webmanager';
22
- import addMetadataRoutes from './routes/meta';
23
- import add404Middleware from './middleware/404';
24
- import addSwaggerMiddleware from './middleware/swagger';
25
- import addCacheMiddleware from './middleware/cache';
26
- import { DatabaseLog } from './logger';
27
-
28
- type PrivateStorageSettings = AceBaseStorageSettings & { info?: string; type?: 'data'|'transaction'|'auth'|'log' };
29
- // type PrivateLocalSettings = AceBaseLocalSettings & { storage: PrivateStorageSettings };
30
-
31
- export class AceBaseServerNotReadyError extends Error {
32
- constructor() { super('Server is not ready yet'); }
33
- }
34
-
35
- type HttpMethod = 'get'|'GET'|'put'|'PUT'|'post'|'POST'|'delete'|'DELETE';
36
-
37
- export class AceBaseServer extends SimpleEventEmitter {
38
-
39
- private _ready: boolean = false;
40
- get isReady() { return this._ready; }
41
-
42
- /**
43
- * Wait for the server to be ready to accept incoming connections
44
- * @param callback (optional) callback function that is called when ready. You can also use the returned promise
45
- * @returns returns a promise that resolves when ready
46
- */
47
- async ready(callback?: () => any) {
48
- if (!this._ready) {
49
- await this.once('ready');
50
- }
51
- callback?.();
52
- }
53
-
54
- /**
55
- * Gets the active server configuration
56
- */
57
- readonly config: AceBaseServerConfig;
58
-
59
- /**
60
- * Gets the url the server is running at
61
- */
62
- get url() {
63
- return `http${this.config.https.enabled ? 's' : ''}://${this.config.host}:${this.config.port}`;
64
- }
65
-
66
- readonly debug: DebugLogger;
67
-
68
- /**
69
- * Gets direct access to the database, this bypasses any security rules and schema validators.
70
- * You can use this to add custom event handlers ("cloud functions") to your database directly.
71
- * NOTE: your code will run in the same thread as the server, make sure you are not performing
72
- * CPU heavy tasks here. If you have to do heavy weightlifting, create a seperate app that connects
73
- * to your server with an AceBaseClient, or execute in a worker thread.
74
- * @example
75
- * server.db.ref('uploads/images').on('child_added', async snap => {
76
- * const image = snap.val();
77
- * const resizedImages = await createImageSizes(image); // Some function that creates multiple image sizes in worker thread
78
- * const targetRef = await server.db.ref('images').push(resizedImages); // Store them somewhere else
79
- * await snap.ref.remove(); // Remove original upload
80
- * });
81
- */
82
- readonly db: AceBase;
83
-
84
- /**
85
- * Exposes the used http frameworks app (currently Express) for external use.
86
- */
87
- readonly app: ReturnType<typeof createApp>;
88
-
89
- private readonly authProviders: { [provider: string]: OAuth2Provider } = {};
90
-
91
- constructor(dbname: string, options?: AceBaseServerSettings) {
92
- super();
93
-
94
- this.config = new AceBaseServerConfig(options);
95
- this.debug = new DebugLogger(this.config.logLevel, `[${dbname}]`.colorize(ColorStyle.green));
96
-
97
- if (this.config.auth.enabled && !this.config.https.enabled) {
98
- this.debug.warn(`WARNING: Authentication is enabled, but the server is not using https. Any password and other data transmitted may be intercepted!`.colorize(ColorStyle.red));
99
- }
100
- else if (!this.config.https.enabled) {
101
- this.debug.warn(`WARNING: Server is not using https, any data transmitted may be intercepted!`.colorize(ColorStyle.red));
102
- }
103
- if (!this.config.auth.enabled) {
104
- this.debug.warn(`WARNING: Authentication is disabled, *anyone* can do *anything* with your data!`.colorize(ColorStyle.red));
105
- }
106
-
107
- // Open database(s)
108
- const dbOptions: AceBaseLocalSettings & { info: string } = {
109
- logLevel: this.config.logLevel,
110
- info: 'realtime database server',
111
- // NEW: Allow storage setting like AceBaseLocalSettings - could allow using other db backend (typed, but undocumented)
112
- storage: this.config.storage || {
113
- path: this.config.path,
114
- removeVoidProperties: true,
115
- },
116
- transactions: this.config.transactions,
117
- ipc: this.config.ipc
118
- };
119
- this.db = new AceBase(dbname, dbOptions);
120
-
121
- const otherDbsPath = `${this.config.path}/${this.db.name}.acebase`;
122
- const authDb = (() => {
123
- if (!this.config.auth.enabled) {
124
- return null;
125
- }
126
- switch (this.config.auth.separateDb) {
127
- case true: return new AceBase('auth', { logLevel: dbOptions.logLevel, storage: <PrivateStorageSettings>{ path: otherDbsPath, removeVoidProperties: true, info: `${dbname} auth database` } });
128
- case 'v2': /*NOT TESTED YET*/return new AceBase(dbname, { logLevel: dbOptions.logLevel, storage: <PrivateStorageSettings>{ type: 'auth', path: this.config.path, removeVoidProperties: true, info: `${dbname} auth database` } });
129
- default: return this.db;
130
- }
131
- })();
132
-
133
- // Create Express app
134
- this.app = createApp({ trustProxy: true, maxPayloadSize: this.config.maxPayloadSize });
135
-
136
- // Initialize and start server
137
- this.init({ authDb });
138
- }
139
-
140
- private async init(env: { authDb?: AceBase }) {
141
- const config = this.config;
142
- const db = this.db;
143
- const authDb = env.authDb;
144
-
145
- // Wait for databases to be ready to use
146
- await Promise.all([
147
- db.ready(),
148
- authDb?.ready()
149
- ]);
150
-
151
- // Create http server
152
- const app = this.app;
153
- const server = config.https.enabled ? createSecureServer(config.https, app) : createServer(app);
154
- const clients = new Map<string, ConnectedClient>();
155
-
156
- const securityRef = authDb ? authDb === db ? db.ref('__auth__/security') : authDb.ref('security') : null;
157
- const authRef = authDb ? authDb === db ? db.ref('__auth__/accounts') : authDb.ref('accounts') : null;
158
- const logRef = authDb ? authDb === db ? db.ref('__log__') : authDb.ref('log') : null;
159
- const logger = new DatabaseLog(logRef);
160
-
161
- // Setup rules
162
- const rulesFilePath = `${this.config.path}/${this.db.name}.acebase/rules.json`;
163
- const rules = new PathBasedRules(rulesFilePath, config.auth.defaultAccessRule, { db, debug: this.debug, authEnabled: this.config.auth.enabled });
164
-
165
- const routeEnv: RouteInitEnvironment = {
166
- config: this.config,
167
- server,
168
- db: db as AceBase & { api: Api },
169
- authDb,
170
- app,
171
- debug: this.debug,
172
- securityRef,
173
- authRef,
174
- log: logger,
175
- tokenSalt: null,
176
- clients,
177
- authCache: null,
178
- authProviders: this.authProviders,
179
- rules
180
- };
181
-
182
- // Add connection middleware
183
- const killConnections = addConnectionMiddleware(routeEnv);
184
-
185
- // Add CORS middleware
186
- addCorsMiddleware(routeEnv);
187
-
188
- // Add cache middleware
189
- addCacheMiddleware(routeEnv);
190
-
191
- if (config.auth.enabled) {
192
- // Setup auth database
193
- await setupAuthentication(routeEnv);
194
-
195
- // Add auth endpoints
196
- const { resetPassword, verifyEmailAddress } = addAuthenticionRoutes(routeEnv);
197
- this.resetPassword = resetPassword;
198
- this.verifyEmailAddress = verifyEmailAddress;
199
- }
200
-
201
- // Add metadata endpoints
202
- addMetadataRoutes(routeEnv);
203
-
204
- // If environment is development, add API docs
205
- if (process.env.NODE_ENV?.trim?.() === 'development') {
206
- this.debug.warn('DEVELOPMENT MODE: adding API docs endpoint at /docs');
207
- addDocsRoute(routeEnv);
208
- addSwaggerMiddleware(routeEnv);
209
- }
210
-
211
- // Add data endpoints
212
- addDataRoutes(routeEnv);
213
-
214
- // Add webmanager endpoints
215
- addWebManagerRoutes(routeEnv);
216
-
217
- // Allow adding custom routes
218
- this.extend = (method: HttpMethod, ext_path: string, handler: (req: HttpRequest, res: HttpResponse) => any) => {
219
- const route = `/ext/${db.name}/${ext_path}`;
220
- this.debug.log(`Extending server: `, method, route);
221
- routeEnv.app[method.toLowerCase()](route, handler);
222
- };
223
-
224
- // Create websocket server
225
- addWebsocketServer(routeEnv);
226
-
227
- // Last but not least, add 404 handler
228
- // DISABLED because it causes server extension routes through server.extend (see above) not be be executed
229
- // add404Middleware(routeEnv);
230
-
231
- // Start listening
232
- server.listen(config.port, config.host, () => {
233
- // Ready!!
234
- this.debug.log(`"${db.name}" database server running at ${this.url}`);
235
- this._ready = true;
236
- this.emitOnce(`ready`);
237
- });
238
-
239
- // Setup pause and resume methods
240
- let paused = false;
241
- this.pause = async () => {
242
- if (paused) { throw new Error('Server is already paused'); }
243
- server.close();
244
- this.debug.warn(`Paused "${db.name}" database server at ${this.url}`);
245
- this.emit('pause');
246
- paused = true;
247
- };
248
- this.resume = async () => {
249
- if (!paused) { throw new Error('Server is not paused'); }
250
- return new Promise(resolve => {
251
- server.listen(config.port, config.host, () => {
252
- this.debug.warn(`Resumed "${db.name}" database server at ${this.url}`);
253
- this.emit('resume');
254
- paused = false;
255
- resolve();
256
- });
257
- })
258
- };
259
-
260
- // Handle SIGINT and shutdown requests
261
- const shutdown = async (request: { sigint: boolean }) => {
262
- this.debug.warn('shutting down server');
263
- routeEnv.rules.stop();
264
-
265
- const getConnectionsCount = () => {
266
- return new Promise<number>((resolve, reject) => {
267
- server.getConnections((err, connections) => {
268
- if (err) { reject(err); }
269
- else { resolve(connections); }
270
- });
271
- });
272
- };
273
- const connections = await getConnectionsCount();
274
- this.debug.log(`Server has ${connections} connections`);
275
-
276
- await new Promise<void>((resolve) => {
277
- // const interval = setInterval(async () => {
278
- // const connections = await getConnectionsCount();
279
- // this.debug.log(`Server still has ${connections} connections`);
280
- // }, 5000);
281
- // interval.unref();
282
-
283
- server.close(err => {
284
- if (err) { console.error(`server.close() error: ${err.message}`); }
285
- else { console.log(`server.close() success`); }
286
- resolve();
287
- });
288
-
289
- // If for some reason connection aren't broken in time - do proceed with shutdown sequence
290
- const timeout = setTimeout(() => {
291
- console.warn(`server.close() timed out, there are still open connections`);
292
- killConnections();
293
- // resolve();
294
- }, 5000);
295
- timeout.unref();
296
-
297
- console.log(`Closing ${clients.size} websocket connections`);
298
- clients.forEach((client, id) => {
299
- const socket = client.socket;
300
- socket.once('disconnect', reason => {
301
- console.log(`Socket ${socket.id} disconnected: ${reason}`);
302
- })
303
- socket.disconnect(true);
304
- });
305
-
306
- // clients.list.slice().forEach(client => {
307
- // client.socket.disconnect(true);
308
- // });
309
- });
310
- this.debug.warn('closing database');
311
- await db.close();
312
- this.debug.warn('shutdown complete');
313
-
314
- // Emit events to let the outside world know we shut down.
315
- // This is especially important if this instance was running in a Node.js cluster: the process will
316
- // not exit automatically after this shutdown because Node.js' IPC channel between worker and master is still open.
317
- // By sending these events, the cluster manager can determine if it should (and when to) execute process.exit()
318
-
319
- // process.emit('acebase-server-shutdown'); // Emit on process
320
- process.emit('beforeExit', request.sigint ? 130 : 0); // Emit on process
321
- try {
322
- process.send && process.send('acebase-server-shutdown'); // Send to master process when running in a Node.js cluster
323
- }
324
- catch(err) {
325
- // IPC Channel has apparently been closed already
326
- }
327
- this.emit('shutdown'); // Emit on AceBaseServer instance
328
- };
329
- this.shutdown = async () => await shutdown({ sigint: false });
330
- process.on('SIGINT', () => shutdown({ sigint: true }));
331
- }
332
-
333
- /**
334
- * Reset a user's password. This can also be done using the auth/reset_password API endpoint
335
- * @param clientIp ip address of the user
336
- * @param code reset code that was sent to the user's email address
337
- * @param newPassword new password chosen by the user
338
- */
339
- resetPassword (clientIp: string, code: string, newPassword: string): Promise<DbUserAccountDetails> {
340
- throw new AceBaseServerNotReadyError();
341
- }
342
-
343
- /**
344
- * Marks a user account's email address as validated. This can also be done using the auth/verify_email API endpoint
345
- * @param clientIp ip address of the user
346
- * @param code verification code sent to the user's email address
347
- */
348
- verifyEmailAddress (clientIp: string, code: string): Promise<void> {
349
- throw new AceBaseServerNotReadyError();
350
- }
351
-
352
- /**
353
- * Shuts down the server. Stops listening for incoming connections, breaks current connections and closes the database.
354
- * Is automatically executed when a "SIGINT" process event is received.
355
- *
356
- * Once the shutdown procedure is completed, it emits a "shutdown" event on the server instance, "acebase-server-shutdown" event on the `process`, and sends an 'acebase-server-shutdown' IPC message if Node.js clustering is used.
357
- * These events can be handled by cluster managing code to `kill` or `exit` the process safely.
358
- */
359
- shutdown() {
360
- throw new AceBaseServerNotReadyError();
361
- }
362
-
363
- /**
364
- * Temporarily stops the server from handling incoming connections, but keeps existing connections open
365
- */
366
- pause(): Promise<void> {
367
- throw new AceBaseServerNotReadyError();
368
- }
369
-
370
- /**
371
- * Resumes handling incoming connections
372
- */
373
- resume(): Promise<void> {
374
- throw new AceBaseServerNotReadyError();
375
- }
376
-
377
- /**
378
- * Extend the server API with your own custom functions. Your handler will be listening
379
- * on path /ext/[db name]/[ext_path].
380
- * @example
381
- * // Server side:
382
- * const _quotes = [...];
383
- * server.extend('get', 'quotes/random', (req, res) => {
384
- * let index = Math.round(Math.random() * _quotes.length);
385
- * res.send(quotes[index]);
386
- * })
387
- * // Client side:
388
- * client.callExtension('get', 'quotes/random')
389
- * .then(quote => {
390
- * console.log(`Got random quote: ${quote}`);
391
- * })
392
- * @param method http method to bind to
393
- * @param ext_path path to bind to (appended to /ext/)
394
- * @param handler your Express request handler callback
395
- */
396
- extend(method: HttpMethod, ext_path: string, handler: (req: HttpRequest, res: HttpResponse) => void) {
397
- throw new AceBaseServerNotReadyError();
398
- }
399
-
400
- /**
401
- * Configure an auth provider to allow users to sign in with Facebook, Google, etc
402
- * @param providerName name of the third party OAuth provider. Eg: "Facebook", "Google", "spotify" etc
403
- * @param settings API key & secret for the OAuth provider
404
- * @returns Returns the created auth provider instance, which can be used to call non-user specific methods the provider might support. (example: the Spotify auth provider supports getClientAuthToken, which allows API calls to be made to the core (non-user) spotify service)
405
- */
406
- configAuthProvider(providerName: string, settings: any) {
407
- if (!this.config.auth.enabled) {
408
- throw new Error(`Authentication is not enabled`);
409
- }
410
- try {
411
- const AuthProvider = oAuth2Providers[providerName];
412
- const provider = new AuthProvider(settings);
413
- this.authProviders[providerName] = provider;
414
- return provider;
415
- }
416
- catch(err) {
417
- throw new Error(`Failed to configure provider ${providerName}: ${err.message}`)
418
- }
419
- }
420
- }
@@ -1,18 +0,0 @@
1
- import { AceBaseEmailRequest } from '../shared/email';
2
-
3
- export interface AceBaseServerEmailServerSettings {
4
- host: string;
5
- port: number;
6
- username?: string;
7
- password?: string;
8
- secure: boolean;
9
- };
10
-
11
- export interface AceBaseServerEmailSettings {
12
-
13
- /** NOT IMPLEMENTED YET - Use send property for your own implementation */
14
- server?: AceBaseServerEmailServerSettings;
15
-
16
- /** function to call when an e-mail needs to be sent */
17
- send: (request: AceBaseEmailRequest) => Promise<void>;
18
- };
@@ -1,241 +0,0 @@
1
- import { AceBaseStorageSettings } from 'acebase';
2
- import { readFileSync } from 'fs';
3
- import { AceBaseServerEmailSettings } from './email';
4
-
5
- export type AceBaseServerHttpsSettings = {
6
- enabled?: boolean;
7
- keyPath?: string;
8
- certPath?: string
9
- pfxPath?: string;
10
- passphrase?: string
11
- } & (
12
- { keyPath: string; certPath: string } |
13
- { pfxPath: string; passphrase: string } |
14
- {}
15
- )
16
-
17
- export class AceBaseServerHttpsConfig {
18
- enabled: boolean = true;
19
- key?: Buffer;
20
- cert?: Buffer;
21
- pfx?: Buffer;
22
- passphrase?: string;
23
-
24
- constructor(settings: AceBaseServerHttpsSettings) {
25
- this.enabled = typeof settings === "object" && settings.enabled !== false;
26
- if (!this.enabled) { return; }
27
- if (settings.keyPath) {
28
- this.key = readFileSync(settings.keyPath);
29
- this.cert = readFileSync(settings.certPath);
30
- }
31
- else if (settings.pfxPath) {
32
- this.pfx = readFileSync(settings.pfxPath);
33
- this.passphrase = settings.passphrase;
34
- }
35
- }
36
- }
37
-
38
- export type AuthAccessDefault = 'deny'|'allow'|'auth';
39
- export const AUTH_ACCESS_DEFAULT: { [key: string]: AuthAccessDefault } = {
40
- DENY_ALL: 'deny',
41
- ALLOW_ALL: 'allow',
42
- ALLOW_AUTHENTICATED: 'auth'
43
- };
44
-
45
- export class AceBaseServerAuthenticationSettings {
46
-
47
- /**
48
- * Whether to enable authorization. Without authorization the entire db can be read and written to by anyone (not recommended 🤷🏼‍♂️)
49
- */
50
- readonly enabled: boolean = true;
51
-
52
- /**
53
- * Whether new users creation is allowed for anyone, or just the admin
54
- */
55
- readonly allowUserSignup: boolean = false;
56
-
57
- /**
58
- * How many new users can sign up per hour per IP address. not implemented yet
59
- */
60
- readonly newUserRateLimit: number = 0;
61
-
62
- /**
63
- * How many minutes before access tokens expire. 0 for no expiration. (not implemented yet)
64
- */
65
- readonly tokensExpire: number = 0;
66
-
67
- /**
68
- * When the server runs for the first time, what defaults to use to generate the rules.json file with. Options are: 'auth' (only authenticated access to db, default), 'deny' (deny access to anyone except admin user), 'allow' (allow access to anyone)
69
- */
70
- readonly defaultAccessRule: AuthAccessDefault = AUTH_ACCESS_DEFAULT.ALLOW_AUTHENTICATED;
71
-
72
- /**
73
- * When the server runs for the first time, what password to use for the admin user. If not supplied, a generated password will be used and shown ONCE in the console output.
74
- */
75
- readonly defaultAdminPassword?: string;
76
-
77
- /**
78
- * Whether to use a separate database for auth and logging. 'v2' will store data in auth.db, which is NOT TESTED YET!
79
- */
80
- readonly separateDb: boolean|'v2' = false;
81
-
82
- constructor(settings: Partial<AceBaseServerAuthenticationSettings>) {
83
- if (typeof settings !== "object") { settings = {}; }
84
- if (typeof settings.enabled === 'boolean') { this.enabled = settings.enabled; }
85
- if (typeof settings.allowUserSignup === 'boolean') { this.allowUserSignup = settings.allowUserSignup; }
86
- if (typeof settings.newUserRateLimit === 'number') { this.newUserRateLimit = settings.newUserRateLimit; }
87
- if (typeof settings.tokensExpire === 'number') { this.tokensExpire = settings.tokensExpire; }
88
- if (typeof settings.defaultAccessRule === 'string') { this.defaultAccessRule = settings.defaultAccessRule; }
89
- if (typeof settings.defaultAdminPassword === 'string') { this.defaultAdminPassword = settings.defaultAdminPassword; }
90
- if (typeof (settings as any).seperateDb === 'boolean') { this.separateDb = (settings as any).seperateDb; } // Handle previous _wrong_ spelling
91
- if (typeof settings.separateDb === 'boolean') { this.separateDb = settings.separateDb; }
92
- }
93
- }
94
-
95
- /**
96
- * TODO: Use AceBaseTransactionLogSettings from 'acebase/src/storage-acebase.js'
97
- */
98
- export class AceBaseServerTransactionSettings {
99
- /**
100
- * Whether to enable transaction logging
101
- */
102
- log: boolean = false;
103
-
104
- /**
105
- * Max age in days to keep transactions in the log file
106
- */
107
- maxAge: number = 30;
108
-
109
- /**
110
- * Whether database write operations should not wait until transaction has been logged
111
- */
112
- noWait: boolean = false;
113
-
114
- constructor(settings: Partial<AceBaseServerTransactionSettings>) {
115
- if (typeof settings !== 'object') { return; }
116
- if (typeof settings.log === 'boolean') { this.log = settings.log; }
117
- if (typeof settings.maxAge === 'number') { this.maxAge = settings.maxAge; }
118
- if (typeof settings.noWait === 'boolean') { this.noWait = settings.noWait; }
119
- }
120
- }
121
-
122
- export interface IPCClientSettings {
123
- /**
124
- * IPC Server host to connect to. Default is `"localhost"`
125
- */
126
- host?: string;
127
-
128
- /**
129
- * IPC Server port number
130
- */
131
- port: number;
132
-
133
- /**
134
- * Whether to use a secure connection to the server. Strongly recommended if `host` is not `"localhost"`. Default is `false`
135
- */
136
- ssl?: boolean;
137
-
138
- /**
139
- * Token used in the IPC Server configuration (optional). The server will refuse connections using the wrong token.
140
- */
141
- token?: string;
142
-
143
- /**
144
- * Determines the role of this IPC client. Only 1 process can be assigned the 'master' role, all other processes must use the role 'worker'
145
- */
146
- role: 'master'|'worker';
147
- }
148
-
149
- export type AceBaseServerSettings = Partial<{
150
- /**
151
- * Level of messages logged to console
152
- */
153
- logLevel: 'verbose'|'log'|'warn'|'error';
154
-
155
- /**
156
- * ip or hostname to start the server on
157
- */
158
- host: string;
159
-
160
- /**
161
- * port number the server will be listening
162
- */
163
- port: number;
164
-
165
- /**
166
- * target directory path to store/open the database. Default is '.'
167
- */
168
- path: string;
169
-
170
- /**
171
- * Whether to use secure sockets layer (ssl)
172
- */
173
- https: AceBaseServerHttpsSettings;
174
-
175
- /**
176
- * settings that define if and how authentication is used
177
- */
178
- authentication: Partial<AceBaseServerAuthenticationSettings>;
179
-
180
- /**
181
- * maximum size to allow for posted data, eg for updating nodes. Default is '10mb'
182
- */
183
- maxPayloadSize: string;
184
-
185
- /**
186
- * Value to use for Access-Control-Allow-Origin CORS header. Default is '*'
187
- */
188
- allowOrigin: string;
189
-
190
- /**
191
- * Email settings that enable AceBaseServer to send e-mails, eg for welcoming new users, to reset passwords, notify of new sign ins etc
192
- */
193
- email: AceBaseServerEmailSettings;
194
-
195
- /**
196
- * Transaction logging settings. Warning: BETA stage, do NOT use in production yet
197
- */
198
- transactions: Partial<AceBaseServerTransactionSettings>;
199
-
200
- /**
201
- * IPC settings for pm2 or cloud-based clusters. BETA stage, see https://github.com/appy-one/acebase-ipc-server
202
- */
203
- ipc: IPCClientSettings;
204
-
205
- /**
206
- * Allows overriding of default storage settings used by the database. ALPHA stage
207
- */
208
- storage: AceBaseStorageSettings;
209
- }>
210
-
211
- export class AceBaseServerConfig {
212
-
213
- readonly logLevel: 'verbose'|'log'|'warn'|'error' = 'log';
214
- readonly host: string = 'localhost';
215
- readonly port: number = 3000;
216
- readonly path: string = '.';
217
- readonly maxPayloadSize: string = '10mb';
218
- readonly allowOrigin: string = '*';
219
- readonly https: AceBaseServerHttpsConfig;
220
- readonly auth: AceBaseServerAuthenticationSettings;
221
- readonly email: AceBaseServerEmailSettings;
222
- readonly transactions: AceBaseServerTransactionSettings;
223
- readonly ipc: IPCClientSettings;
224
- readonly storage?: AceBaseStorageSettings;
225
-
226
- constructor(settings: AceBaseServerSettings) {
227
- if (typeof settings !== "object") { settings = {}; }
228
- if (typeof settings.logLevel === 'string') { this.logLevel = settings.logLevel; }
229
- if (typeof settings.host === 'string') { this.host = settings.host; }
230
- if (typeof settings.port === 'number') { this.port = settings.port; }
231
- if (typeof settings.path === 'string') { this.path = settings.path; }
232
- this.https = new AceBaseServerHttpsConfig(settings.https);
233
- this.auth = new AceBaseServerAuthenticationSettings(settings.authentication);
234
- if (typeof settings.maxPayloadSize === 'string') { this.maxPayloadSize = settings.maxPayloadSize; }
235
- if (typeof settings.allowOrigin === 'string') { this.allowOrigin = settings.allowOrigin; }
236
- if (typeof settings.email === 'object') { this.email = settings.email; }
237
- this.transactions = new AceBaseServerTransactionSettings(settings.transactions);
238
- this.ipc = settings.ipc;
239
- if (typeof settings.storage === 'object') { this.storage = settings.storage; }
240
- }
241
- }