acebase-server 1.16.2 → 1.17.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 (250) hide show
  1. package/README.md +180 -10
  2. package/build-vars.js +2 -1
  3. package/dist/cjs/auth.js +88 -88
  4. package/dist/cjs/cluster.js +56 -56
  5. package/dist/cjs/index.d.ts +1 -1
  6. package/dist/cjs/index.js +24 -24
  7. package/dist/cjs/logger.js +73 -73
  8. package/dist/cjs/middleware/404.js +14 -14
  9. package/dist/cjs/middleware/admin-only.js +28 -28
  10. package/dist/cjs/middleware/cache.js +14 -14
  11. package/dist/cjs/middleware/connection.js +49 -49
  12. package/dist/cjs/middleware/context.js +20 -20
  13. package/dist/cjs/middleware/cors.js +50 -50
  14. package/dist/cjs/middleware/swagger.js +17 -17
  15. package/dist/cjs/middleware/user.js +57 -57
  16. package/dist/cjs/oauth-providers/dropbox.js +109 -109
  17. package/dist/cjs/oauth-providers/facebook.js +85 -85
  18. package/dist/cjs/oauth-providers/google.js +119 -119
  19. package/dist/cjs/oauth-providers/index.js +26 -26
  20. package/dist/cjs/oauth-providers/instagram.js +80 -80
  21. package/dist/cjs/oauth-providers/oauth-provider.js +20 -20
  22. package/dist/cjs/oauth-providers/spotify.js +113 -113
  23. package/dist/cjs/routes/auth-change-password.js +87 -87
  24. package/dist/cjs/routes/auth-delete.js +52 -52
  25. package/dist/cjs/routes/auth-forgot-password.js +77 -77
  26. package/dist/cjs/routes/auth-reset-password.js +97 -97
  27. package/dist/cjs/routes/auth-signin.js +46 -46
  28. package/dist/cjs/routes/auth-signout.js +61 -61
  29. package/dist/cjs/routes/auth-signup.js +142 -142
  30. package/dist/cjs/routes/auth-state.js +25 -25
  31. package/dist/cjs/routes/auth-update.js +131 -131
  32. package/dist/cjs/routes/auth-verify-email.js +71 -71
  33. package/dist/cjs/routes/auth.js +57 -54
  34. package/dist/cjs/routes/data-exists.js +33 -33
  35. package/dist/cjs/routes/data-export.js +48 -48
  36. package/dist/cjs/routes/data-get.js +70 -66
  37. package/dist/cjs/routes/data-import.js +54 -54
  38. package/dist/cjs/routes/data-index-create.js +42 -42
  39. package/dist/cjs/routes/data-index-delete.js +33 -33
  40. package/dist/cjs/routes/data-index-list.js +31 -31
  41. package/dist/cjs/routes/data-query.js +80 -70
  42. package/dist/cjs/routes/data-reflect.js +97 -86
  43. package/dist/cjs/routes/data-schema-get.js +36 -36
  44. package/dist/cjs/routes/data-schema-set.js +30 -30
  45. package/dist/cjs/routes/data-schema-test.js +43 -43
  46. package/dist/cjs/routes/data-schemas-list.js +32 -32
  47. package/dist/cjs/routes/data-set.js +85 -75
  48. package/dist/cjs/routes/data-sync-changes.js +81 -67
  49. package/dist/cjs/routes/data-sync-mutations.js +81 -67
  50. package/dist/cjs/routes/data-transaction.js +159 -139
  51. package/dist/cjs/routes/data-update.js +86 -75
  52. package/dist/cjs/routes/data.js +62 -62
  53. package/dist/cjs/routes/docs.js +258 -251
  54. package/dist/cjs/routes/meta-info.js +63 -63
  55. package/dist/cjs/routes/meta-logs.js +49 -49
  56. package/dist/cjs/routes/meta-ping.js +11 -11
  57. package/dist/cjs/routes/meta-stats.js +27 -27
  58. package/dist/cjs/routes/meta.js +19 -19
  59. package/dist/cjs/routes/oauth2-init.js +54 -54
  60. package/dist/cjs/routes/oauth2-refresh.js +42 -42
  61. package/dist/cjs/routes/oauth2-signin.js +265 -265
  62. package/dist/cjs/routes/webmanager.js +26 -26
  63. package/dist/cjs/rules.js +380 -167
  64. package/dist/cjs/sandbox.js +28 -0
  65. package/dist/cjs/schema/user.js +24 -24
  66. package/dist/cjs/server.js +415 -407
  67. package/dist/cjs/settings/email.js +2 -2
  68. package/dist/cjs/settings/index.js +175 -172
  69. package/dist/cjs/shared/clients.js +26 -26
  70. package/dist/cjs/shared/email.js +2 -2
  71. package/dist/cjs/shared/env.js +2 -2
  72. package/dist/cjs/shared/error.js +33 -33
  73. package/dist/cjs/shared/http.js +28 -28
  74. package/dist/cjs/shared/password.js +45 -45
  75. package/dist/cjs/shared/rootpath.js +16 -16
  76. package/dist/cjs/shared/signin.js +143 -143
  77. package/dist/cjs/shared/simple-fetch.js +76 -76
  78. package/dist/cjs/shared/tokens.js +79 -79
  79. package/dist/cjs/shared/validate.js +61 -61
  80. package/dist/cjs/start.js +53 -53
  81. package/dist/cjs/test.js +10 -10
  82. package/dist/cjs/websocket/index.js +331 -319
  83. package/dist/cjs/websocket/manager.js +15 -15
  84. package/dist/cjs/websocket/socket.io.js +76 -76
  85. package/dist/esm/auth.js +75 -75
  86. package/dist/esm/cluster.js +54 -54
  87. package/dist/esm/index.d.ts +1 -1
  88. package/dist/esm/index.js +4 -4
  89. package/dist/esm/logger.js +51 -51
  90. package/dist/esm/middleware/404.js +10 -10
  91. package/dist/esm/middleware/admin-only.js +24 -24
  92. package/dist/esm/middleware/cache.js +10 -10
  93. package/dist/esm/middleware/connection.js +45 -45
  94. package/dist/esm/middleware/context.js +16 -16
  95. package/dist/esm/middleware/cors.js +44 -44
  96. package/dist/esm/middleware/swagger.js +13 -13
  97. package/dist/esm/middleware/user.js +44 -44
  98. package/dist/esm/oauth-providers/dropbox.js +90 -90
  99. package/dist/esm/oauth-providers/facebook.js +66 -66
  100. package/dist/esm/oauth-providers/google.js +96 -96
  101. package/dist/esm/oauth-providers/index.js +18 -18
  102. package/dist/esm/oauth-providers/instagram.js +61 -61
  103. package/dist/esm/oauth-providers/oauth-provider.js +16 -16
  104. package/dist/esm/oauth-providers/spotify.js +92 -92
  105. package/dist/esm/routes/auth-change-password.js +72 -72
  106. package/dist/esm/routes/auth-delete.js +37 -37
  107. package/dist/esm/routes/auth-forgot-password.js +62 -62
  108. package/dist/esm/routes/auth-reset-password.js +81 -81
  109. package/dist/esm/routes/auth-signin.js +33 -33
  110. package/dist/esm/routes/auth-signout.js +47 -47
  111. package/dist/esm/routes/auth-signup.js +127 -127
  112. package/dist/esm/routes/auth-state.js +12 -12
  113. package/dist/esm/routes/auth-update.js +116 -116
  114. package/dist/esm/routes/auth-verify-email.js +57 -57
  115. package/dist/esm/routes/auth.js +53 -50
  116. package/dist/esm/routes/data-exists.js +20 -20
  117. package/dist/esm/routes/data-export.js +35 -35
  118. package/dist/esm/routes/data-get.js +56 -52
  119. package/dist/esm/routes/data-import.js +41 -41
  120. package/dist/esm/routes/data-index-create.js +28 -28
  121. package/dist/esm/routes/data-index-delete.js +20 -20
  122. package/dist/esm/routes/data-index-list.js +18 -18
  123. package/dist/esm/routes/data-query.js +66 -56
  124. package/dist/esm/routes/data-reflect.js +83 -72
  125. package/dist/esm/routes/data-schema-get.js +23 -23
  126. package/dist/esm/routes/data-schema-set.js +17 -17
  127. package/dist/esm/routes/data-schema-test.js +29 -29
  128. package/dist/esm/routes/data-schemas-list.js +19 -19
  129. package/dist/esm/routes/data-set.js +70 -60
  130. package/dist/esm/routes/data-sync-changes.js +67 -53
  131. package/dist/esm/routes/data-sync-mutations.js +67 -53
  132. package/dist/esm/routes/data-transaction.js +142 -123
  133. package/dist/esm/routes/data-update.js +71 -60
  134. package/dist/esm/routes/data.js +58 -58
  135. package/dist/esm/routes/docs.js +252 -245
  136. package/dist/esm/routes/meta-info.js +59 -59
  137. package/dist/esm/routes/meta-logs.js +35 -35
  138. package/dist/esm/routes/meta-ping.js +7 -7
  139. package/dist/esm/routes/meta-stats.js +14 -14
  140. package/dist/esm/routes/meta.js +15 -15
  141. package/dist/esm/routes/oauth2-init.js +41 -41
  142. package/dist/esm/routes/oauth2-refresh.js +29 -29
  143. package/dist/esm/routes/oauth2-signin.js +251 -251
  144. package/dist/esm/routes/webmanager.js +22 -22
  145. package/dist/esm/rules.js +374 -163
  146. package/dist/esm/sandbox.js +12 -0
  147. package/dist/esm/schema/user.js +19 -19
  148. package/dist/esm/server.js +395 -387
  149. package/dist/esm/settings/email.js +1 -1
  150. package/dist/esm/settings/index.js +168 -165
  151. package/dist/esm/shared/clients.js +22 -22
  152. package/dist/esm/shared/email.js +1 -1
  153. package/dist/esm/shared/env.js +1 -1
  154. package/dist/esm/shared/error.js +25 -25
  155. package/dist/esm/shared/http.js +22 -22
  156. package/dist/esm/shared/password.js +38 -38
  157. package/dist/esm/shared/rootpath.js +13 -13
  158. package/dist/esm/shared/signin.js +128 -128
  159. package/dist/esm/shared/simple-fetch.js +59 -59
  160. package/dist/esm/shared/tokens.js +72 -72
  161. package/dist/esm/shared/validate.js +41 -41
  162. package/dist/esm/start.js +50 -50
  163. package/dist/esm/test.js +8 -8
  164. package/dist/esm/websocket/index.js +313 -302
  165. package/dist/esm/websocket/manager.js +11 -11
  166. package/dist/esm/websocket/socket.io.js +71 -71
  167. package/dist/types/auth.d.ts +3 -3
  168. package/dist/types/cluster.d.ts +1 -1
  169. package/dist/types/index.d.ts +4 -4
  170. package/dist/types/logger.d.ts +35 -35
  171. package/dist/types/middleware/404.d.ts +7 -7
  172. package/dist/types/middleware/admin-only.d.ts +19 -19
  173. package/dist/types/middleware/cache.d.ts +3 -3
  174. package/dist/types/middleware/connection.d.ts +7 -7
  175. package/dist/types/middleware/context.d.ts +3 -3
  176. package/dist/types/middleware/cors.d.ts +25 -25
  177. package/dist/types/middleware/swagger.d.ts +3 -3
  178. package/dist/types/middleware/user.d.ts +2 -2
  179. package/dist/types/oauth-providers/dropbox.d.ts +52 -52
  180. package/dist/types/oauth-providers/facebook.d.ts +41 -41
  181. package/dist/types/oauth-providers/google.d.ts +43 -43
  182. package/dist/types/oauth-providers/index.d.ts +10 -10
  183. package/dist/types/oauth-providers/instagram.d.ts +50 -50
  184. package/dist/types/oauth-providers/oauth-provider.d.ts +74 -74
  185. package/dist/types/oauth-providers/spotify.d.ts +53 -53
  186. package/dist/types/routes/auth-change-password.d.ts +20 -20
  187. package/dist/types/routes/auth-delete.d.ts +16 -16
  188. package/dist/types/routes/auth-forgot-password.d.ts +16 -16
  189. package/dist/types/routes/auth-reset-password.d.ts +23 -23
  190. package/dist/types/routes/auth-signin.d.ts +24 -24
  191. package/dist/types/routes/auth-signout.d.ts +14 -14
  192. package/dist/types/routes/auth-signup.d.ts +32 -32
  193. package/dist/types/routes/auth-state.d.ts +13 -13
  194. package/dist/types/routes/auth-update.d.ts +33 -33
  195. package/dist/types/routes/auth-verify-email.d.ts +21 -21
  196. package/dist/types/routes/auth.d.ts +6 -6
  197. package/dist/types/routes/data-exists.d.ts +9 -9
  198. package/dist/types/routes/data-export.d.ts +10 -10
  199. package/dist/types/routes/data-get.d.ts +14 -14
  200. package/dist/types/routes/data-import.d.ts +13 -13
  201. package/dist/types/routes/data-index-create.d.ts +51 -51
  202. package/dist/types/routes/data-index-delete.d.ts +17 -17
  203. package/dist/types/routes/data-index-list.d.ts +21 -21
  204. package/dist/types/routes/data-query.d.ts +49 -49
  205. package/dist/types/routes/data-reflect.d.ts +29 -29
  206. package/dist/types/routes/data-schema-get.d.ts +11 -11
  207. package/dist/types/routes/data-schema-set.d.ts +19 -19
  208. package/dist/types/routes/data-schema-test.d.ts +19 -19
  209. package/dist/types/routes/data-schemas-list.d.ts +11 -11
  210. package/dist/types/routes/data-set.d.ts +27 -27
  211. package/dist/types/routes/data-sync-changes.d.ts +25 -28
  212. package/dist/types/routes/data-sync-mutations.d.ts +25 -28
  213. package/dist/types/routes/data-transaction.d.ts +34 -34
  214. package/dist/types/routes/data-update.d.ts +27 -27
  215. package/dist/types/routes/data.d.ts +3 -3
  216. package/dist/types/routes/docs.d.ts +3 -3
  217. package/dist/types/routes/meta-info.d.ts +11 -11
  218. package/dist/types/routes/meta-logs.d.ts +20 -20
  219. package/dist/types/routes/meta-ping.d.ts +7 -7
  220. package/dist/types/routes/meta-stats.d.ts +13 -13
  221. package/dist/types/routes/meta.d.ts +3 -3
  222. package/dist/types/routes/oauth2-init.d.ts +13 -13
  223. package/dist/types/routes/oauth2-refresh.d.ts +17 -17
  224. package/dist/types/routes/oauth2-signin.d.ts +15 -15
  225. package/dist/types/routes/webmanager.d.ts +3 -3
  226. package/dist/types/rules.d.ts +73 -34
  227. package/dist/types/sandbox.d.ts +3 -0
  228. package/dist/types/schema/user.d.ts +85 -85
  229. package/dist/types/server.d.ts +117 -111
  230. package/dist/types/settings/email.d.ts +14 -14
  231. package/dist/types/settings/index.d.ts +195 -187
  232. package/dist/types/shared/clients.d.ts +46 -46
  233. package/dist/types/shared/email.d.ts +34 -34
  234. package/dist/types/shared/env.d.ts +47 -44
  235. package/dist/types/shared/error.d.ts +15 -15
  236. package/dist/types/shared/http.d.ts +22 -21
  237. package/dist/types/shared/password.d.ts +19 -19
  238. package/dist/types/shared/rootpath.d.ts +2 -2
  239. package/dist/types/shared/signin.d.ts +31 -31
  240. package/dist/types/shared/simple-fetch.d.ts +21 -21
  241. package/dist/types/shared/tokens.d.ts +24 -24
  242. package/dist/types/shared/validate.d.ts +22 -22
  243. package/dist/types/start.d.ts +1 -1
  244. package/dist/types/test.d.ts +1 -1
  245. package/dist/types/websocket/index.d.ts +6 -6
  246. package/dist/types/websocket/manager.d.ts +99 -99
  247. package/dist/types/websocket/socket.io.d.ts +10 -10
  248. package/package.json +4 -4
  249. package/src/routes/data-set.yaml +5 -5
  250. package/src/routes/data-update.yaml +4 -4
@@ -1,74 +1,74 @@
1
- "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
- Object.defineProperty(exports, "__esModule", { value: true });
12
- exports.DatabaseLog = void 0;
13
- class DatabaseLog {
14
- constructor(logRef) {
15
- this.logRef = logRef;
16
- }
17
- /**
18
- * Logs an action initiated by a client/user with a positive or negative outcome. Used by `success` and `failure`
19
- * @param action action identifier
20
- * @param success whether the action was successful
21
- * @param details any additional details to be logged
22
- */
23
- event(action, details) {
24
- var _a;
25
- return __awaiter(this, void 0, void 0, function* () {
26
- yield ((_a = this.logRef) === null || _a === void 0 ? void 0 : _a.push(Object.assign({ type: 'event', action, date: new Date() }, details)));
27
- });
28
- }
29
- /**
30
- * Logs a system warning
31
- * @param action action identifier
32
- * @param code warning code
33
- * @param details any additional details to be logged
34
- */
35
- warning(action, code, details) {
36
- var _a;
37
- return __awaiter(this, void 0, void 0, function* () {
38
- yield ((_a = this.logRef) === null || _a === void 0 ? void 0 : _a.push(Object.assign({ type: 'warning', action, code, date: new Date() }, details)));
39
- });
40
- }
41
- /**
42
- * Logs a system or client/user error
43
- * @param action action identifier
44
- * @param code error code
45
- * @param details any additional details to be logged
46
- */
47
- error(action, code, details, unexpectedError) {
48
- var _a, _b, _c, _d;
49
- return __awaiter(this, void 0, void 0, function* () {
50
- const errorDetails = unexpectedError instanceof Error
51
- ? { error: (_a = unexpectedError.stack) !== null && _a !== void 0 ? _a : unexpectedError.message }
52
- : { error: (_c = (_b = unexpectedError === null || unexpectedError === void 0 ? void 0 : unexpectedError.message) !== null && _b !== void 0 ? _b : unexpectedError === null || unexpectedError === void 0 ? void 0 : unexpectedError.toString()) !== null && _c !== void 0 ? _c : null };
53
- yield ((_d = this.logRef) === null || _d === void 0 ? void 0 : _d.push(Object.assign(Object.assign({ type: 'error', action, code, date: new Date() }, errorDetails), details)));
54
- });
55
- }
56
- /**
57
- * Query the logs
58
- * @returns
59
- */
60
- query() {
61
- if (!this.logRef) {
62
- throw new Error('Logging is not enabled');
63
- }
64
- return this.logRef.query();
65
- }
66
- /**
67
- * Reference to the logs database collection
68
- */
69
- get ref() {
70
- return this === null || this === void 0 ? void 0 : this.logRef;
71
- }
72
- }
73
- exports.DatabaseLog = DatabaseLog;
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.DatabaseLog = void 0;
13
+ class DatabaseLog {
14
+ constructor(logRef) {
15
+ this.logRef = logRef;
16
+ }
17
+ /**
18
+ * Logs an action initiated by a client/user with a positive or negative outcome. Used by `success` and `failure`
19
+ * @param action action identifier
20
+ * @param success whether the action was successful
21
+ * @param details any additional details to be logged
22
+ */
23
+ event(action, details) {
24
+ var _a;
25
+ return __awaiter(this, void 0, void 0, function* () {
26
+ yield ((_a = this.logRef) === null || _a === void 0 ? void 0 : _a.push(Object.assign({ type: 'event', action, date: new Date() }, details)));
27
+ });
28
+ }
29
+ /**
30
+ * Logs a system warning
31
+ * @param action action identifier
32
+ * @param code warning code
33
+ * @param details any additional details to be logged
34
+ */
35
+ warning(action, code, details) {
36
+ var _a;
37
+ return __awaiter(this, void 0, void 0, function* () {
38
+ yield ((_a = this.logRef) === null || _a === void 0 ? void 0 : _a.push(Object.assign({ type: 'warning', action, code, date: new Date() }, details)));
39
+ });
40
+ }
41
+ /**
42
+ * Logs a system or client/user error
43
+ * @param action action identifier
44
+ * @param code error code
45
+ * @param details any additional details to be logged
46
+ */
47
+ error(action, code, details, unexpectedError) {
48
+ var _a, _b, _c, _d;
49
+ return __awaiter(this, void 0, void 0, function* () {
50
+ const errorDetails = unexpectedError instanceof Error
51
+ ? { error: (_a = unexpectedError.stack) !== null && _a !== void 0 ? _a : unexpectedError.message }
52
+ : { error: (_c = (_b = unexpectedError === null || unexpectedError === void 0 ? void 0 : unexpectedError.message) !== null && _b !== void 0 ? _b : unexpectedError === null || unexpectedError === void 0 ? void 0 : unexpectedError.toString()) !== null && _c !== void 0 ? _c : null };
53
+ yield ((_d = this.logRef) === null || _d === void 0 ? void 0 : _d.push(Object.assign(Object.assign({ type: 'error', action, code, date: new Date() }, errorDetails), details)));
54
+ });
55
+ }
56
+ /**
57
+ * Query the logs
58
+ * @returns
59
+ */
60
+ query() {
61
+ if (!this.logRef) {
62
+ throw new Error('Logging is not enabled');
63
+ }
64
+ return this.logRef.query();
65
+ }
66
+ /**
67
+ * Reference to the logs database collection
68
+ */
69
+ get ref() {
70
+ return this === null || this === void 0 ? void 0 : this.logRef;
71
+ }
72
+ }
73
+ exports.DatabaseLog = DatabaseLog;
74
74
  //# sourceMappingURL=logger.js.map
@@ -1,15 +1,15 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.addMiddleware = void 0;
4
- /**
5
- * Adds 404 middleware. Add this as very last handler!
6
- * @param env
7
- */
8
- const addMiddleware = (env) => {
9
- env.app.use((req, res, next) => {
10
- res.status(404).send('Not Found');
11
- });
12
- };
13
- exports.addMiddleware = addMiddleware;
14
- exports.default = exports.addMiddleware;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.addMiddleware = void 0;
4
+ /**
5
+ * Adds 404 middleware. This binds to `env.app` so routes added to `env.router` always come first, even if they are added after the 404 handler
6
+ * @param env
7
+ */
8
+ const addMiddleware = (env) => {
9
+ env.app.use((req, res, next) => {
10
+ res.status(404).send('Not Found');
11
+ });
12
+ };
13
+ exports.addMiddleware = addMiddleware;
14
+ exports.default = exports.addMiddleware;
15
15
  //# sourceMappingURL=404.js.map
@@ -1,29 +1,29 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.adminOnly = void 0;
4
- const error_1 = require("../shared/error");
5
- /**
6
- * Middleware function that checks if the current user is `admin`. An 403 Forbidden error will be sent in the response if
7
- * authentication is enabled on the server and the user is not signed in as admin.
8
- *
9
- * Can be applied to any route by adding it in the router chain.
10
- * @example
11
- * app.get('/endpoint', adminOnly(env), (req, res) => {
12
- * // If we get here we are either an admin,
13
- * // or the server doesn't have authentication enabled.
14
- * })
15
- * @param env Middle
16
- * @param errorMessage
17
- * @returns
18
- */
19
- const adminOnly = (env, errorMessage = 'only admin can perform this operation') => {
20
- return (req, res, next) => {
21
- if (env.config.auth.enabled && (!req.user || req.user.uid !== 'admin')) {
22
- return (0, error_1.sendUnauthorizedError)(res, 'admin_only', errorMessage);
23
- }
24
- next();
25
- };
26
- };
27
- exports.adminOnly = adminOnly;
28
- exports.default = exports.adminOnly;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.adminOnly = void 0;
4
+ const error_1 = require("../shared/error");
5
+ /**
6
+ * Middleware function that checks if the current user is `admin`. An 403 Forbidden error will be sent in the response if
7
+ * authentication is enabled on the server and the user is not signed in as admin.
8
+ *
9
+ * Can be applied to any route by adding it in the router chain.
10
+ * @example
11
+ * app.get('/endpoint', adminOnly(env), (req, res) => {
12
+ * // If we get here we are either an admin,
13
+ * // or the server doesn't have authentication enabled.
14
+ * })
15
+ * @param env Middle
16
+ * @param errorMessage
17
+ * @returns
18
+ */
19
+ const adminOnly = (env, errorMessage = 'only admin can perform this operation') => {
20
+ return (req, res, next) => {
21
+ if (env.config.auth.enabled && (!req.user || req.user.uid !== 'admin')) {
22
+ return (0, error_1.sendUnauthorizedError)(res, 'admin_only', errorMessage);
23
+ }
24
+ next();
25
+ };
26
+ };
27
+ exports.adminOnly = adminOnly;
28
+ exports.default = exports.adminOnly;
29
29
  //# sourceMappingURL=admin-only.js.map
@@ -1,15 +1,15 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.addMiddleware = void 0;
4
- const addMiddleware = (env) => {
5
- env.app.use((req, res, next) => {
6
- // Disable cache for GET requests to make sure browsers do not use cached responses
7
- if (req.method === 'GET') {
8
- res.setHeader('Cache-Control', 'no-cache');
9
- }
10
- next();
11
- });
12
- };
13
- exports.addMiddleware = addMiddleware;
14
- exports.default = exports.addMiddleware;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.addMiddleware = void 0;
4
+ const addMiddleware = (env) => {
5
+ env.router.use((req, res, next) => {
6
+ // Disable cache for GET requests to make sure browsers do not use cached responses
7
+ if (req.method === 'GET') {
8
+ res.setHeader('Cache-Control', 'no-cache');
9
+ }
10
+ next();
11
+ });
12
+ };
13
+ exports.addMiddleware = addMiddleware;
14
+ exports.default = exports.addMiddleware;
15
15
  //# sourceMappingURL=cache.js.map
@@ -1,50 +1,50 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.addMiddleware = void 0;
4
- /**
5
- * Adds connection management middleware. Add this as very first handler!
6
- * @param env
7
- */
8
- const addMiddleware = (env) => {
9
- const sockets = new Set();
10
- let terminating = false;
11
- const destroySocket = (socket) => {
12
- socket.destroy();
13
- };
14
- const addConnection = (socket) => {
15
- // console.log(`event: server.connection`);
16
- if (terminating) {
17
- destroySocket(socket);
18
- }
19
- else {
20
- sockets.add(socket);
21
- socket.once('close', () => {
22
- // console.log(`event: socket.close`);
23
- sockets.delete(socket);
24
- });
25
- }
26
- };
27
- env.server.on('connection', addConnection);
28
- env.server.on('secureConnection', addConnection);
29
- // Don't enable this: it'll make every other request real slow
30
- // env.app.use((req, res, next) => {
31
- // res.setHeader('Connection', 'close');
32
- // next();
33
- // });
34
- const terminate = () => {
35
- terminating = true;
36
- console.warn(`Terminating ${sockets.size} open connections`);
37
- sockets.forEach(socket => {
38
- try {
39
- destroySocket(socket);
40
- }
41
- catch (err) {
42
- console.error(`Cannot destroy socket: ${err.message}`);
43
- }
44
- });
45
- };
46
- return terminate;
47
- };
48
- exports.addMiddleware = addMiddleware;
49
- exports.default = exports.addMiddleware;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.addMiddleware = void 0;
4
+ /**
5
+ * Adds connection management middleware. Add this as very first handler!
6
+ * @param env
7
+ */
8
+ const addMiddleware = (env) => {
9
+ const sockets = new Set();
10
+ let terminating = false;
11
+ const destroySocket = (socket) => {
12
+ socket.destroy();
13
+ };
14
+ const addConnection = (socket) => {
15
+ // console.log(`event: server.connection`);
16
+ if (terminating) {
17
+ destroySocket(socket);
18
+ }
19
+ else {
20
+ sockets.add(socket);
21
+ socket.once('close', () => {
22
+ // console.log(`event: socket.close`);
23
+ sockets.delete(socket);
24
+ });
25
+ }
26
+ };
27
+ env.server.on('connection', addConnection);
28
+ env.server.on('secureConnection', addConnection);
29
+ // Don't enable this: it'll make every other request real slow
30
+ // env.app.use((req, res, next) => {
31
+ // res.setHeader('Connection', 'close');
32
+ // next();
33
+ // });
34
+ const terminate = () => {
35
+ terminating = true;
36
+ console.warn(`Terminating ${sockets.size} open connections`);
37
+ sockets.forEach(socket => {
38
+ try {
39
+ destroySocket(socket);
40
+ }
41
+ catch (err) {
42
+ console.error(`Cannot destroy socket: ${err.message}`);
43
+ }
44
+ });
45
+ };
46
+ return terminate;
47
+ };
48
+ exports.addMiddleware = addMiddleware;
49
+ exports.default = exports.addMiddleware;
50
50
  //# sourceMappingURL=connection.js.map
@@ -1,21 +1,21 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.addMiddleware = void 0;
4
- const addMiddleware = (env) => {
5
- env.app.use((req, res, next) => {
6
- // Setup AceBase context, to allow clients to pass contextual info with data updates,
7
- // that will be sent along to data event subscribers on affected data.
8
- const context = req.get('AceBase-Context') || '{}';
9
- try {
10
- req.context = JSON.parse(context);
11
- }
12
- catch (err) {
13
- env.debug.error(`Failed to parse AceBase-Context header: "${context}" in request at ${req.url} from client ${req.ip}`);
14
- return res.status(500).end('Invalid request context');
15
- }
16
- next();
17
- });
18
- };
19
- exports.addMiddleware = addMiddleware;
20
- exports.default = exports.addMiddleware;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.addMiddleware = void 0;
4
+ const addMiddleware = (env) => {
5
+ env.router.use((req, res, next) => {
6
+ // Setup AceBase context, to allow clients to pass contextual info with data updates,
7
+ // that will be sent along to data event subscribers on affected data.
8
+ const context = req.get('AceBase-Context') || '{}';
9
+ try {
10
+ req.context = JSON.parse(context);
11
+ }
12
+ catch (err) {
13
+ env.debug.error(`Failed to parse AceBase-Context header: "${context}" in request at ${req.url} from client ${req.ip}`);
14
+ return res.status(500).end('Invalid request context');
15
+ }
16
+ next();
17
+ });
18
+ };
19
+ exports.addMiddleware = addMiddleware;
20
+ exports.default = exports.addMiddleware;
21
21
  //# sourceMappingURL=context.js.map
@@ -1,51 +1,51 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.addMiddleware = exports.getCorsHeaders = exports.getCorsOptions = void 0;
4
- /**
5
- * Gets CORS options that are compatible with the 'cors' package (used by Socket.IO 3+)
6
- * @param allowedOrigins
7
- * @returns
8
- */
9
- const getCorsOptions = (allowedOrigins) => {
10
- return {
11
- origin: allowedOrigins === '*' ? true : allowedOrigins === '' ? false : allowedOrigins.split(/,\s*/),
12
- methods: 'GET,PUT,POST,DELETE,OPTIONS',
13
- allowedHeaders: 'Content-Type, Authorization, Content-Length, Accept, Origin, X-Requested-With, AceBase-Context',
14
- };
15
- };
16
- exports.getCorsOptions = getCorsOptions;
17
- /**
18
- * Gets CORS headers that can be sent in preflight (OPTIONS) requests
19
- * @param allowedOrigins configured allowed origin(s). Examples: `'https://my.server.com'` for a specific allowed origin, `'*'` for any origin (returns current origin), `''` to disable CORS (only allows localhost), or `'http://server1.com,https://server1.com,https://server2.com'` for multiple allowed origins
20
- * @param currentOrigin current origin from request headers
21
- * @returns
22
- */
23
- const getCorsHeaders = (allowedOrigins, currentOrigin) => {
24
- const corsOptions = (0, exports.getCorsOptions)(allowedOrigins);
25
- const origins = typeof corsOptions.origin === 'boolean'
26
- ? corsOptions.origin ? currentOrigin !== null && currentOrigin !== void 0 ? currentOrigin : '*' : ''
27
- : corsOptions.origin instanceof Array ? corsOptions.origin.join(',') : corsOptions.origin;
28
- return {
29
- 'Access-Control-Allow-Origin': origins,
30
- 'Access-Control-Allow-Methods': corsOptions.methods,
31
- 'Access-Control-Allow-Headers': corsOptions.allowedHeaders,
32
- 'Access-Control-Expose-Headers': 'Date, AceBase-Context', // Prevent browsers from stripping these headers from the response for programmatic access in cross-origin requests
33
- };
34
- };
35
- exports.getCorsHeaders = getCorsHeaders;
36
- const addMiddleware = (env) => {
37
- env.app.use((req, res, next) => {
38
- const headers = (0, exports.getCorsHeaders)(env.config.allowOrigin, req.headers.origin);
39
- for (const name in headers) {
40
- res.setHeader(name, headers[name]);
41
- }
42
- if (req.method === 'OPTIONS') {
43
- // Return 200 OK
44
- return res.status(200).end();
45
- }
46
- next();
47
- });
48
- };
49
- exports.addMiddleware = addMiddleware;
50
- exports.default = exports.addMiddleware;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.addMiddleware = exports.getCorsHeaders = exports.getCorsOptions = void 0;
4
+ /**
5
+ * Gets CORS options that are compatible with the 'cors' package (used by Socket.IO 3+)
6
+ * @param allowedOrigins
7
+ * @returns
8
+ */
9
+ const getCorsOptions = (allowedOrigins) => {
10
+ return {
11
+ origin: allowedOrigins === '*' ? true : allowedOrigins === '' ? false : allowedOrigins.split(/,\s*/),
12
+ methods: 'GET,PUT,POST,DELETE,OPTIONS',
13
+ allowedHeaders: 'Content-Type, Authorization, Content-Length, Accept, Origin, X-Requested-With, AceBase-Context',
14
+ };
15
+ };
16
+ exports.getCorsOptions = getCorsOptions;
17
+ /**
18
+ * Gets CORS headers that can be sent in preflight (OPTIONS) requests
19
+ * @param allowedOrigins configured allowed origin(s). Examples: `'https://my.server.com'` for a specific allowed origin, `'*'` for any origin (returns current origin), `''` to disable CORS (only allows localhost), or `'http://server1.com,https://server1.com,https://server2.com'` for multiple allowed origins
20
+ * @param currentOrigin current origin from request headers
21
+ * @returns
22
+ */
23
+ const getCorsHeaders = (allowedOrigins, currentOrigin) => {
24
+ const corsOptions = (0, exports.getCorsOptions)(allowedOrigins);
25
+ const origins = typeof corsOptions.origin === 'boolean'
26
+ ? corsOptions.origin ? currentOrigin !== null && currentOrigin !== void 0 ? currentOrigin : '*' : ''
27
+ : corsOptions.origin instanceof Array ? corsOptions.origin.join(',') : corsOptions.origin;
28
+ return {
29
+ 'Access-Control-Allow-Origin': origins,
30
+ 'Access-Control-Allow-Methods': corsOptions.methods,
31
+ 'Access-Control-Allow-Headers': corsOptions.allowedHeaders,
32
+ 'Access-Control-Expose-Headers': 'Date, AceBase-Context', // Prevent browsers from stripping these headers from the response for programmatic access in cross-origin requests
33
+ };
34
+ };
35
+ exports.getCorsHeaders = getCorsHeaders;
36
+ const addMiddleware = (env) => {
37
+ env.router.use((req, res, next) => {
38
+ const headers = (0, exports.getCorsHeaders)(env.config.allowOrigin, req.headers.origin);
39
+ for (const name in headers) {
40
+ res.setHeader(name, headers[name]);
41
+ }
42
+ if (req.method === 'OPTIONS') {
43
+ // Return 200 OK
44
+ return res.status(200).end();
45
+ }
46
+ next();
47
+ });
48
+ };
49
+ exports.addMiddleware = addMiddleware;
50
+ exports.default = exports.addMiddleware;
51
51
  //# sourceMappingURL=cors.js.map
@@ -1,18 +1,18 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.addMiddleware = void 0;
4
- const addMiddleware = (env) => {
5
- env.app.use((req, res, next) => {
6
- // Swagger UI escapes path variables, so "some/path" in a path variable of an endpoint becomes "some%2Fpath". This middleware fixes that
7
- if (req.path.includes('%2F')) {
8
- const [url, query] = req.url.split('?');
9
- const newUrl = url.replace(/\%2F/g, '/') + (query ? `?${query}` : '');
10
- env.debug.warn(`API: replacing escaped slashes in request path for Swagger UI: ${req.url} -> ${newUrl}`);
11
- req.url = newUrl;
12
- }
13
- next();
14
- });
15
- };
16
- exports.addMiddleware = addMiddleware;
17
- exports.default = exports.addMiddleware;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.addMiddleware = void 0;
4
+ const addMiddleware = (env) => {
5
+ env.router.use((req, res, next) => {
6
+ // Swagger UI escapes path variables, so "some/path" in a path variable of an endpoint becomes "some%2Fpath". This middleware fixes that
7
+ if (req.path.includes('%2F')) {
8
+ const [url, query] = req.url.split('?');
9
+ const newUrl = url.replace(/\%2F/g, '/') + (query ? `?${query}` : '');
10
+ env.debug.warn(`API: replacing escaped slashes in request path for Swagger UI: ${req.url} -> ${newUrl}`);
11
+ req.url = newUrl;
12
+ }
13
+ next();
14
+ });
15
+ };
16
+ exports.addMiddleware = addMiddleware;
17
+ exports.default = exports.addMiddleware;
18
18
  //# sourceMappingURL=swagger.js.map