acebase-server 1.16.2 → 1.18.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 (252) hide show
  1. package/README.md +180 -10
  2. package/bin/acebase-server.js +8 -0
  3. package/build-vars.js +2 -1
  4. package/dist/cjs/auth.js +88 -88
  5. package/dist/cjs/cluster.js +6 -56
  6. package/dist/cjs/index.d.ts +1 -1
  7. package/dist/cjs/index.js +24 -24
  8. package/dist/cjs/logger.js +73 -73
  9. package/dist/cjs/middleware/404.js +14 -14
  10. package/dist/cjs/middleware/admin-only.js +28 -28
  11. package/dist/cjs/middleware/cache.js +14 -14
  12. package/dist/cjs/middleware/connection.js +49 -49
  13. package/dist/cjs/middleware/context.js +20 -20
  14. package/dist/cjs/middleware/cors.js +50 -50
  15. package/dist/cjs/middleware/swagger.js +17 -17
  16. package/dist/cjs/middleware/user.js +57 -57
  17. package/dist/cjs/oauth-providers/dropbox.js +109 -109
  18. package/dist/cjs/oauth-providers/facebook.js +85 -85
  19. package/dist/cjs/oauth-providers/google.js +119 -119
  20. package/dist/cjs/oauth-providers/index.js +26 -26
  21. package/dist/cjs/oauth-providers/instagram.js +80 -80
  22. package/dist/cjs/oauth-providers/oauth-provider.js +20 -20
  23. package/dist/cjs/oauth-providers/spotify.js +113 -113
  24. package/dist/cjs/routes/auth-change-password.js +87 -87
  25. package/dist/cjs/routes/auth-delete.js +52 -52
  26. package/dist/cjs/routes/auth-forgot-password.js +77 -77
  27. package/dist/cjs/routes/auth-reset-password.js +97 -97
  28. package/dist/cjs/routes/auth-signin.js +46 -46
  29. package/dist/cjs/routes/auth-signout.js +61 -61
  30. package/dist/cjs/routes/auth-signup.js +142 -142
  31. package/dist/cjs/routes/auth-state.js +25 -25
  32. package/dist/cjs/routes/auth-update.js +131 -131
  33. package/dist/cjs/routes/auth-verify-email.js +71 -71
  34. package/dist/cjs/routes/auth.js +57 -54
  35. package/dist/cjs/routes/data-exists.js +33 -33
  36. package/dist/cjs/routes/data-export.js +48 -48
  37. package/dist/cjs/routes/data-get.js +70 -66
  38. package/dist/cjs/routes/data-import.js +54 -54
  39. package/dist/cjs/routes/data-index-create.js +42 -42
  40. package/dist/cjs/routes/data-index-delete.js +33 -33
  41. package/dist/cjs/routes/data-index-list.js +31 -31
  42. package/dist/cjs/routes/data-query.js +80 -70
  43. package/dist/cjs/routes/data-reflect.js +97 -86
  44. package/dist/cjs/routes/data-schema-get.js +36 -36
  45. package/dist/cjs/routes/data-schema-set.js +30 -30
  46. package/dist/cjs/routes/data-schema-test.js +43 -43
  47. package/dist/cjs/routes/data-schemas-list.js +32 -32
  48. package/dist/cjs/routes/data-set.js +85 -75
  49. package/dist/cjs/routes/data-sync-changes.js +81 -67
  50. package/dist/cjs/routes/data-sync-mutations.js +81 -67
  51. package/dist/cjs/routes/data-transaction.js +159 -139
  52. package/dist/cjs/routes/data-update.js +86 -75
  53. package/dist/cjs/routes/data.js +62 -62
  54. package/dist/cjs/routes/docs.js +258 -251
  55. package/dist/cjs/routes/meta-info.js +63 -63
  56. package/dist/cjs/routes/meta-logs.js +49 -49
  57. package/dist/cjs/routes/meta-ping.js +11 -11
  58. package/dist/cjs/routes/meta-stats.js +27 -27
  59. package/dist/cjs/routes/meta.js +19 -19
  60. package/dist/cjs/routes/oauth2-init.js +54 -54
  61. package/dist/cjs/routes/oauth2-refresh.js +42 -42
  62. package/dist/cjs/routes/oauth2-signin.js +265 -265
  63. package/dist/cjs/routes/webmanager.js +26 -26
  64. package/dist/cjs/rules.js +380 -167
  65. package/dist/cjs/sandbox.js +28 -0
  66. package/dist/cjs/schema/user.js +24 -24
  67. package/dist/cjs/server.js +410 -407
  68. package/dist/cjs/settings/email.js +2 -2
  69. package/dist/cjs/settings/index.js +175 -172
  70. package/dist/cjs/shared/clients.js +26 -26
  71. package/dist/cjs/shared/email.js +2 -2
  72. package/dist/cjs/shared/env.js +2 -2
  73. package/dist/cjs/shared/error.js +33 -33
  74. package/dist/cjs/shared/http.js +28 -28
  75. package/dist/cjs/shared/password.js +45 -45
  76. package/dist/cjs/shared/rootpath.js +16 -16
  77. package/dist/cjs/shared/signin.js +143 -143
  78. package/dist/cjs/shared/simple-fetch.js +76 -76
  79. package/dist/cjs/shared/tokens.js +79 -79
  80. package/dist/cjs/shared/validate.js +61 -61
  81. package/dist/cjs/start.js +119 -53
  82. package/dist/cjs/test.js +10 -10
  83. package/dist/cjs/websocket/index.js +331 -319
  84. package/dist/cjs/websocket/manager.js +15 -15
  85. package/dist/cjs/websocket/socket.io.js +76 -76
  86. package/dist/esm/auth.js +75 -75
  87. package/dist/esm/cluster.js +6 -54
  88. package/dist/esm/index.d.ts +1 -1
  89. package/dist/esm/index.js +4 -4
  90. package/dist/esm/logger.js +51 -51
  91. package/dist/esm/middleware/404.js +10 -10
  92. package/dist/esm/middleware/admin-only.js +24 -24
  93. package/dist/esm/middleware/cache.js +10 -10
  94. package/dist/esm/middleware/connection.js +45 -45
  95. package/dist/esm/middleware/context.js +16 -16
  96. package/dist/esm/middleware/cors.js +44 -44
  97. package/dist/esm/middleware/swagger.js +13 -13
  98. package/dist/esm/middleware/user.js +44 -44
  99. package/dist/esm/oauth-providers/dropbox.js +90 -90
  100. package/dist/esm/oauth-providers/facebook.js +66 -66
  101. package/dist/esm/oauth-providers/google.js +96 -96
  102. package/dist/esm/oauth-providers/index.js +18 -18
  103. package/dist/esm/oauth-providers/instagram.js +61 -61
  104. package/dist/esm/oauth-providers/oauth-provider.js +16 -16
  105. package/dist/esm/oauth-providers/spotify.js +92 -92
  106. package/dist/esm/routes/auth-change-password.js +72 -72
  107. package/dist/esm/routes/auth-delete.js +37 -37
  108. package/dist/esm/routes/auth-forgot-password.js +62 -62
  109. package/dist/esm/routes/auth-reset-password.js +81 -81
  110. package/dist/esm/routes/auth-signin.js +33 -33
  111. package/dist/esm/routes/auth-signout.js +47 -47
  112. package/dist/esm/routes/auth-signup.js +127 -127
  113. package/dist/esm/routes/auth-state.js +12 -12
  114. package/dist/esm/routes/auth-update.js +116 -116
  115. package/dist/esm/routes/auth-verify-email.js +57 -57
  116. package/dist/esm/routes/auth.js +53 -50
  117. package/dist/esm/routes/data-exists.js +20 -20
  118. package/dist/esm/routes/data-export.js +35 -35
  119. package/dist/esm/routes/data-get.js +56 -52
  120. package/dist/esm/routes/data-import.js +41 -41
  121. package/dist/esm/routes/data-index-create.js +28 -28
  122. package/dist/esm/routes/data-index-delete.js +20 -20
  123. package/dist/esm/routes/data-index-list.js +18 -18
  124. package/dist/esm/routes/data-query.js +66 -56
  125. package/dist/esm/routes/data-reflect.js +83 -72
  126. package/dist/esm/routes/data-schema-get.js +23 -23
  127. package/dist/esm/routes/data-schema-set.js +17 -17
  128. package/dist/esm/routes/data-schema-test.js +29 -29
  129. package/dist/esm/routes/data-schemas-list.js +19 -19
  130. package/dist/esm/routes/data-set.js +70 -60
  131. package/dist/esm/routes/data-sync-changes.js +67 -53
  132. package/dist/esm/routes/data-sync-mutations.js +67 -53
  133. package/dist/esm/routes/data-transaction.js +142 -123
  134. package/dist/esm/routes/data-update.js +71 -60
  135. package/dist/esm/routes/data.js +58 -58
  136. package/dist/esm/routes/docs.js +252 -245
  137. package/dist/esm/routes/meta-info.js +59 -59
  138. package/dist/esm/routes/meta-logs.js +35 -35
  139. package/dist/esm/routes/meta-ping.js +7 -7
  140. package/dist/esm/routes/meta-stats.js +14 -14
  141. package/dist/esm/routes/meta.js +15 -15
  142. package/dist/esm/routes/oauth2-init.js +41 -41
  143. package/dist/esm/routes/oauth2-refresh.js +29 -29
  144. package/dist/esm/routes/oauth2-signin.js +251 -251
  145. package/dist/esm/routes/webmanager.js +22 -22
  146. package/dist/esm/rules.js +374 -163
  147. package/dist/esm/sandbox.js +12 -0
  148. package/dist/esm/schema/user.js +19 -19
  149. package/dist/esm/server.js +395 -387
  150. package/dist/esm/settings/email.js +1 -1
  151. package/dist/esm/settings/index.js +168 -165
  152. package/dist/esm/shared/clients.js +22 -22
  153. package/dist/esm/shared/email.js +1 -1
  154. package/dist/esm/shared/env.js +1 -1
  155. package/dist/esm/shared/error.js +25 -25
  156. package/dist/esm/shared/http.js +22 -22
  157. package/dist/esm/shared/password.js +38 -38
  158. package/dist/esm/shared/rootpath.js +13 -13
  159. package/dist/esm/shared/signin.js +128 -128
  160. package/dist/esm/shared/simple-fetch.js +59 -59
  161. package/dist/esm/shared/tokens.js +72 -72
  162. package/dist/esm/shared/validate.js +41 -41
  163. package/dist/esm/start.js +116 -50
  164. package/dist/esm/test.js +8 -8
  165. package/dist/esm/websocket/index.js +313 -302
  166. package/dist/esm/websocket/manager.js +11 -11
  167. package/dist/esm/websocket/socket.io.js +71 -71
  168. package/dist/types/auth.d.ts +3 -3
  169. package/dist/types/cluster.d.ts +6 -1
  170. package/dist/types/index.d.ts +4 -4
  171. package/dist/types/logger.d.ts +35 -35
  172. package/dist/types/middleware/404.d.ts +7 -7
  173. package/dist/types/middleware/admin-only.d.ts +19 -19
  174. package/dist/types/middleware/cache.d.ts +3 -3
  175. package/dist/types/middleware/connection.d.ts +7 -7
  176. package/dist/types/middleware/context.d.ts +3 -3
  177. package/dist/types/middleware/cors.d.ts +25 -25
  178. package/dist/types/middleware/swagger.d.ts +3 -3
  179. package/dist/types/middleware/user.d.ts +2 -2
  180. package/dist/types/oauth-providers/dropbox.d.ts +52 -52
  181. package/dist/types/oauth-providers/facebook.d.ts +41 -41
  182. package/dist/types/oauth-providers/google.d.ts +43 -43
  183. package/dist/types/oauth-providers/index.d.ts +10 -10
  184. package/dist/types/oauth-providers/instagram.d.ts +50 -50
  185. package/dist/types/oauth-providers/oauth-provider.d.ts +74 -74
  186. package/dist/types/oauth-providers/spotify.d.ts +53 -53
  187. package/dist/types/routes/auth-change-password.d.ts +20 -20
  188. package/dist/types/routes/auth-delete.d.ts +16 -16
  189. package/dist/types/routes/auth-forgot-password.d.ts +16 -16
  190. package/dist/types/routes/auth-reset-password.d.ts +23 -23
  191. package/dist/types/routes/auth-signin.d.ts +24 -24
  192. package/dist/types/routes/auth-signout.d.ts +14 -14
  193. package/dist/types/routes/auth-signup.d.ts +32 -32
  194. package/dist/types/routes/auth-state.d.ts +13 -13
  195. package/dist/types/routes/auth-update.d.ts +33 -33
  196. package/dist/types/routes/auth-verify-email.d.ts +21 -21
  197. package/dist/types/routes/auth.d.ts +6 -6
  198. package/dist/types/routes/data-exists.d.ts +9 -9
  199. package/dist/types/routes/data-export.d.ts +10 -10
  200. package/dist/types/routes/data-get.d.ts +14 -14
  201. package/dist/types/routes/data-import.d.ts +13 -13
  202. package/dist/types/routes/data-index-create.d.ts +51 -51
  203. package/dist/types/routes/data-index-delete.d.ts +17 -17
  204. package/dist/types/routes/data-index-list.d.ts +21 -21
  205. package/dist/types/routes/data-query.d.ts +49 -49
  206. package/dist/types/routes/data-reflect.d.ts +29 -29
  207. package/dist/types/routes/data-schema-get.d.ts +11 -11
  208. package/dist/types/routes/data-schema-set.d.ts +20 -19
  209. package/dist/types/routes/data-schema-test.d.ts +19 -19
  210. package/dist/types/routes/data-schemas-list.d.ts +11 -11
  211. package/dist/types/routes/data-set.d.ts +27 -27
  212. package/dist/types/routes/data-sync-changes.d.ts +25 -28
  213. package/dist/types/routes/data-sync-mutations.d.ts +25 -28
  214. package/dist/types/routes/data-transaction.d.ts +34 -34
  215. package/dist/types/routes/data-update.d.ts +27 -27
  216. package/dist/types/routes/data.d.ts +3 -3
  217. package/dist/types/routes/docs.d.ts +3 -3
  218. package/dist/types/routes/meta-info.d.ts +11 -11
  219. package/dist/types/routes/meta-logs.d.ts +20 -20
  220. package/dist/types/routes/meta-ping.d.ts +7 -7
  221. package/dist/types/routes/meta-stats.d.ts +13 -13
  222. package/dist/types/routes/meta.d.ts +3 -3
  223. package/dist/types/routes/oauth2-init.d.ts +13 -13
  224. package/dist/types/routes/oauth2-refresh.d.ts +17 -17
  225. package/dist/types/routes/oauth2-signin.d.ts +15 -15
  226. package/dist/types/routes/webmanager.d.ts +3 -3
  227. package/dist/types/rules.d.ts +73 -34
  228. package/dist/types/sandbox.d.ts +3 -0
  229. package/dist/types/schema/user.d.ts +85 -85
  230. package/dist/types/server.d.ts +117 -111
  231. package/dist/types/settings/email.d.ts +14 -14
  232. package/dist/types/settings/index.d.ts +195 -187
  233. package/dist/types/shared/clients.d.ts +46 -46
  234. package/dist/types/shared/email.d.ts +34 -34
  235. package/dist/types/shared/env.d.ts +47 -44
  236. package/dist/types/shared/error.d.ts +15 -15
  237. package/dist/types/shared/http.d.ts +22 -21
  238. package/dist/types/shared/password.d.ts +19 -19
  239. package/dist/types/shared/rootpath.d.ts +2 -2
  240. package/dist/types/shared/signin.d.ts +31 -31
  241. package/dist/types/shared/simple-fetch.d.ts +21 -21
  242. package/dist/types/shared/tokens.d.ts +24 -24
  243. package/dist/types/shared/validate.d.ts +22 -22
  244. package/dist/types/start.d.ts +1 -1
  245. package/dist/types/test.d.ts +1 -1
  246. package/dist/types/websocket/index.d.ts +6 -6
  247. package/dist/types/websocket/manager.d.ts +99 -99
  248. package/dist/types/websocket/socket.io.d.ts +10 -10
  249. package/package.json +7 -4
  250. package/src/routes/data-schema-set.yaml +4 -0
  251. package/src/routes/data-set.yaml +5 -5
  252. package/src/routes/data-update.yaml +4 -4
@@ -1,53 +1,57 @@
1
- import { Transport } from 'acebase-core';
2
- import { sendUnauthorizedError } from '../shared/error.js';
3
- export const addRoute = (env) => {
4
- env.app.get(`/data/${env.db.name}/*`, async (req, res) => {
5
- // Request data
6
- const path = req.path.slice(env.db.name.length + 7);
7
- const access = env.rules.userHasAccess(req.user, path, false);
8
- if (!access.allow) {
9
- return sendUnauthorizedError(res, access.code, access.message);
10
- }
11
- const options = {};
12
- if (req.query.include) {
13
- options.include = req.query.include.split(',');
14
- }
15
- if (req.query.exclude) {
16
- options.exclude = req.query.exclude.split(',');
17
- }
18
- if (typeof req.query.child_objects === 'boolean') {
19
- options.child_objects = req.query.child_objects;
20
- }
21
- if (path === '') {
22
- // If user has access to the root of database (NOT recommended for others than admin...)
23
- // Do not return private server data. If the admin user wants access, they should use
24
- // direct requests on those paths (GET /data/dbname/__auth__), or use reflection
25
- if (options.include) {
26
- // Remove all includes for private paths
27
- options.include = options.include.filter(path => !path.startsWith('__'));
28
- }
29
- // Add private paths to exclude
30
- options.exclude = [...options.exclude || [], '__auth__', '__log__'];
31
- }
32
- try {
33
- // const snap = await db.ref(path).get(options);
34
- // const value = snap.val(), context = snap.context();
35
- const { value, context } = await env.db.api.get(path, options);
36
- if (!env.config.transactions?.log) {
37
- delete context.acebase_cursor;
38
- }
39
- const serialized = Transport.serialize(value);
40
- res.setHeader('AceBase-Context', JSON.stringify(context));
41
- res.send({
42
- exists: value !== null,
43
- val: serialized.val,
44
- map: serialized.map,
45
- });
46
- }
47
- catch (err) {
48
- res.status(500).send(err);
49
- }
50
- });
51
- };
52
- export default addRoute;
1
+ import { Transport } from 'acebase-core';
2
+ import { sendUnauthorizedError } from '../shared/error.js';
3
+ export const addRoute = (env) => {
4
+ env.router.get(`/data/${env.db.name}/*`, async (req, res) => {
5
+ // Request data
6
+ const path = req.path.slice(env.db.name.length + 7);
7
+ // Pre-check read access
8
+ let access = await env.rules.isOperationAllowed(req.user, path, 'get');
9
+ if (!access.allow) {
10
+ return sendUnauthorizedError(res, access.code, access.message);
11
+ }
12
+ const options = {};
13
+ if (req.query.include) {
14
+ options.include = req.query.include.split(',');
15
+ }
16
+ if (req.query.exclude) {
17
+ options.exclude = req.query.exclude.split(',');
18
+ }
19
+ if (typeof req.query.child_objects === 'boolean') {
20
+ options.child_objects = req.query.child_objects;
21
+ }
22
+ if (path === '') {
23
+ // If user has access to the root of database (NOT recommended for others than admin...)
24
+ // Do not return private server data. If the admin user wants access, they should use
25
+ // direct requests on those paths (GET /data/dbname/__auth__), or use reflection
26
+ if (options.include) {
27
+ // Remove all includes for private paths
28
+ options.include = options.include.filter(path => !path.startsWith('__'));
29
+ }
30
+ // Add private paths to exclude
31
+ options.exclude = [...options.exclude || [], '__auth__', '__log__'];
32
+ }
33
+ // Check 'get' access
34
+ access = await env.rules.isOperationAllowed(req.user, path, 'get', { context: req.context, options });
35
+ if (!access.allow) {
36
+ return sendUnauthorizedError(res, access.code, access.message);
37
+ }
38
+ try {
39
+ const { value, context } = await env.db.api.get(path, options);
40
+ if (!env.config.transactions?.log) {
41
+ delete context.acebase_cursor;
42
+ }
43
+ const serialized = Transport.serialize(value);
44
+ res.setHeader('AceBase-Context', JSON.stringify(context));
45
+ res.send({
46
+ exists: value !== null,
47
+ val: serialized.val,
48
+ map: serialized.map,
49
+ });
50
+ }
51
+ catch (err) {
52
+ res.status(500).send(err);
53
+ }
54
+ });
55
+ };
56
+ export default addRoute;
53
57
  //# sourceMappingURL=data-get.js.map
@@ -1,42 +1,42 @@
1
- import { sendUnauthorizedError } from '../shared/error.js';
2
- export const addRoute = (env) => {
3
- env.app.post(`/import/${env.db.name}/*`, async (req, res) => {
4
- // Import API
5
- const path = req.path.slice(env.db.name.length + 9);
6
- const access = env.rules.userHasAccess(req.user, path, false);
7
- if (!access.allow) {
8
- return sendUnauthorizedError(res, access.code, access.message);
9
- }
10
- const format = req.query.format || 'json';
11
- const suppress_events = req.query.suppress_events === '1';
12
- req.pause(); // Switch to non-flowing mode so we can use .read() upon request
13
- let eof = false;
14
- req.once('end', () => { eof = true; });
15
- const read = async (length) => {
16
- let chunk = req.read();
17
- if (chunk === null && !eof) {
18
- await new Promise(resolve => req.once('readable', resolve));
19
- chunk = req.read();
20
- }
21
- // env.debug.verbose(`Received chunk: `, chunk);
22
- return chunk;
23
- };
24
- const ref = env.db.ref(path);
25
- try {
26
- await ref.import(read, { format, suppress_events });
27
- res.send({ success: true });
28
- }
29
- catch (err) {
30
- env.debug.error(`Error importing data for path "/${path}": `, err);
31
- if (!res.headersSent) {
32
- res.statusCode = 500;
33
- res.send({ success: false, reason: err.message });
34
- }
35
- }
36
- finally {
37
- res.end();
38
- }
39
- });
40
- };
41
- export default addRoute;
1
+ import { sendUnauthorizedError } from '../shared/error.js';
2
+ export const addRoute = (env) => {
3
+ env.router.post(`/import/${env.db.name}/*`, async (req, res) => {
4
+ // Import API
5
+ const path = req.path.slice(env.db.name.length + 9);
6
+ const access = await env.rules.isOperationAllowed(req.user, path, 'import', { context: req.context });
7
+ if (!access.allow) {
8
+ return sendUnauthorizedError(res, access.code, access.message);
9
+ }
10
+ const format = req.query.format || 'json';
11
+ const suppress_events = req.query.suppress_events === '1';
12
+ req.pause(); // Switch to non-flowing mode so we can use .read() upon request
13
+ let eof = false;
14
+ req.once('end', () => { eof = true; });
15
+ const read = async (length) => {
16
+ let chunk = req.read();
17
+ if (chunk === null && !eof) {
18
+ await new Promise(resolve => req.once('readable', resolve));
19
+ chunk = req.read();
20
+ }
21
+ // env.debug.verbose(`Received chunk: `, chunk);
22
+ return chunk;
23
+ };
24
+ const ref = env.db.ref(path);
25
+ try {
26
+ await ref.import(read, { format, suppress_events });
27
+ res.send({ success: true });
28
+ }
29
+ catch (err) {
30
+ env.debug.error(`Error importing data for path "/${path}": `, err);
31
+ if (!res.headersSent) {
32
+ res.statusCode = 500;
33
+ res.send({ success: false, reason: err.message });
34
+ }
35
+ }
36
+ finally {
37
+ res.end();
38
+ }
39
+ });
40
+ };
41
+ export default addRoute;
42
42
  //# sourceMappingURL=data-import.js.map
@@ -1,29 +1,29 @@
1
- import adminOnly from '../middleware/admin-only.js';
2
- import { sendError } from '../shared/error.js';
3
- export const addRoute = (env) => {
4
- const handleRequest = async (req, res) => {
5
- try {
6
- const data = req.body;
7
- await env.db.indexes.create(data.path, data.key, data.options);
8
- res.contentType('application/json').send({ success: true });
9
- }
10
- catch (err) {
11
- env.debug.error(`failed to perform index action`, err);
12
- sendError(res, err);
13
- }
14
- };
15
- env.app.post(`/index/${env.db.name}`, adminOnly(env), async (req, res) => {
16
- // Legacy endpoint that was designed to handle multiple actions
17
- // The only action ever implemented was 'create', so we'll handle that here
18
- if (req.body?.action !== 'create') {
19
- return sendError(res, { code: 'invalid_action', message: 'Invalid action' });
20
- }
21
- handleRequest(req, res);
22
- });
23
- env.app.post(`/index/${env.db.name}/create`, adminOnly(env), async (req, res) => {
24
- // New dedicated create endpoint
25
- handleRequest(req, res);
26
- });
27
- };
28
- export default addRoute;
1
+ import adminOnly from '../middleware/admin-only.js';
2
+ import { sendError } from '../shared/error.js';
3
+ export const addRoute = (env) => {
4
+ const handleRequest = async (req, res) => {
5
+ try {
6
+ const data = req.body;
7
+ await env.db.indexes.create(data.path, data.key, data.options);
8
+ res.contentType('application/json').send({ success: true });
9
+ }
10
+ catch (err) {
11
+ env.debug.error(`failed to perform index action`, err);
12
+ sendError(res, err);
13
+ }
14
+ };
15
+ env.router.post(`/index/${env.db.name}`, adminOnly(env), async (req, res) => {
16
+ // Legacy endpoint that was designed to handle multiple actions
17
+ // The only action ever implemented was 'create', so we'll handle that here
18
+ if (req.body?.action !== 'create') {
19
+ return sendError(res, { code: 'invalid_action', message: 'Invalid action' });
20
+ }
21
+ handleRequest(req, res);
22
+ });
23
+ env.router.post(`/index/${env.db.name}/create`, adminOnly(env), async (req, res) => {
24
+ // New dedicated create endpoint
25
+ handleRequest(req, res);
26
+ });
27
+ };
28
+ export default addRoute;
29
29
  //# sourceMappingURL=data-index-create.js.map
@@ -1,21 +1,21 @@
1
- import adminOnly from '../middleware/admin-only.js';
2
- import { sendError } from '../shared/error.js';
3
- export const addRoute = (env) => {
4
- env.app.post(`/index/${env.db.name}/delete`, adminOnly(env), async (req, res) => {
5
- // Delete an index
6
- try {
7
- const data = req.body;
8
- if (!data.fileName) {
9
- throw new Error('fileName not given');
10
- }
11
- await env.db.indexes.delete(data.fileName); // Requires newer acebase & acebase-core packages
12
- res.contentType('application/json').send({ success: true });
13
- }
14
- catch (err) {
15
- env.debug.error(`failed to perform index action`, err);
16
- sendError(res, err);
17
- }
18
- });
19
- };
20
- export default addRoute;
1
+ import adminOnly from '../middleware/admin-only.js';
2
+ import { sendError } from '../shared/error.js';
3
+ export const addRoute = (env) => {
4
+ env.router.post(`/index/${env.db.name}/delete`, adminOnly(env), async (req, res) => {
5
+ // Delete an index
6
+ try {
7
+ const data = req.body;
8
+ if (!data.fileName) {
9
+ throw new Error('fileName not given');
10
+ }
11
+ await env.db.indexes.delete(data.fileName); // Requires newer acebase & acebase-core packages
12
+ res.contentType('application/json').send({ success: true });
13
+ }
14
+ catch (err) {
15
+ env.debug.error(`failed to perform index action`, err);
16
+ sendError(res, err);
17
+ }
18
+ });
19
+ };
20
+ export default addRoute;
21
21
  //# sourceMappingURL=data-index-delete.js.map
@@ -1,19 +1,19 @@
1
- import adminOnly from '../middleware/admin-only.js';
2
- import { sendError } from '../shared/error.js';
3
- export const addRoute = (env) => {
4
- env.app.get(`/index/${env.db.name}`, adminOnly(env), async (req, res) => {
5
- // Get all indexes
6
- try {
7
- const indexes = await env.db.indexes.get();
8
- res.contentType('application/json').send(indexes.map(index => {
9
- const { path, key, caseSensitive, textLocale, includeKeys, indexMetadataKeys, type, fileName, description } = index;
10
- return { path, key, caseSensitive, textLocale, includeKeys, indexMetadataKeys, type, fileName, description };
11
- }));
12
- }
13
- catch (err) {
14
- sendError(res, err);
15
- }
16
- });
17
- };
18
- export default addRoute;
1
+ import adminOnly from '../middleware/admin-only.js';
2
+ import { sendError } from '../shared/error.js';
3
+ export const addRoute = (env) => {
4
+ env.router.get(`/index/${env.db.name}`, adminOnly(env), async (req, res) => {
5
+ // Get all indexes
6
+ try {
7
+ const indexes = await env.db.indexes.get();
8
+ res.contentType('application/json').send(indexes.map(index => {
9
+ const { path, key, caseSensitive, textLocale, includeKeys, indexMetadataKeys, type, fileName, description } = index;
10
+ return { path, key, caseSensitive, textLocale, includeKeys, indexMetadataKeys, type, fileName, description };
11
+ }));
12
+ }
13
+ catch (err) {
14
+ sendError(res, err);
15
+ }
16
+ });
17
+ };
18
+ export default addRoute;
19
19
  //# sourceMappingURL=data-index-list.js.map
@@ -1,57 +1,67 @@
1
- import { Transport } from 'acebase-core';
2
- import { sendError, sendUnauthorizedError } from '../shared/error.js';
3
- export const addRoute = (env) => {
4
- env.app.post(`/query/${env.db.name}/*`, async (req, res) => {
5
- // Execute query
6
- const path = req.path.slice(env.db.name.length + 8);
7
- const access = env.rules.userHasAccess(req.user, path, false);
8
- if (!access.allow) {
9
- return sendUnauthorizedError(res, access.code, access.message);
10
- }
11
- const data = Transport.deserialize(req.body);
12
- if (typeof data !== 'object' || typeof data.query !== 'object' || typeof data.options !== 'object') {
13
- return sendError(res, { code: 'invalid_request', message: 'Invalid query request' });
14
- }
15
- const query = data.query;
16
- const options = data.options;
17
- if (options.monitor === true) {
18
- options.monitor = { add: true, change: true, remove: true };
19
- }
20
- if (typeof options.monitor === 'object' && (options.monitor.add || options.monitor.change || options.monitor.remove)) {
21
- const queryId = data.query_id;
22
- const clientId = data.client_id;
23
- const client = env.clients.get(clientId);
24
- client.realtimeQueries[queryId] = { path, query, options };
25
- const sendEvent = event => {
26
- const client = env.clients.get(clientId);
27
- if (!client) {
28
- return false;
29
- } // Not connected, stop subscription
30
- if (!env.rules.userHasAccess(client.user, event.path, false).allow) {
31
- return false; // Access denied, stop subscription
32
- }
33
- event.query_id = queryId;
34
- const data = Transport.serialize(event);
35
- client.socket.emit('query-event', data);
36
- };
37
- options.eventHandler = sendEvent;
38
- }
39
- try {
40
- const { results, context } = await env.db.api.query(path, query, options);
41
- if (!env.config.transactions?.log) {
42
- delete context.acebase_cursor;
43
- }
44
- const response = {
45
- count: results.length,
46
- list: results, // []
47
- };
48
- res.setHeader('AceBase-Context', JSON.stringify(context));
49
- res.send(Transport.serialize(response));
50
- }
51
- catch (err) {
52
- sendError(res, { code: 'unknown', message: err.message });
53
- }
54
- });
55
- };
56
- export default addRoute;
1
+ import { Transport } from 'acebase-core';
2
+ import { sendError, sendUnauthorizedError } from '../shared/error.js';
3
+ export const addRoute = (env) => {
4
+ env.router.post(`/query/${env.db.name}/*`, async (req, res) => {
5
+ // Execute query
6
+ const path = req.path.slice(env.db.name.length + 8);
7
+ const access = await env.rules.isOperationAllowed(req.user, path, 'query', { context: req.context });
8
+ if (!access.allow) {
9
+ return sendUnauthorizedError(res, access.code, access.message);
10
+ }
11
+ const data = Transport.deserialize(req.body);
12
+ if (typeof data !== 'object' || typeof data.query !== 'object' || typeof data.options !== 'object') {
13
+ return sendError(res, { code: 'invalid_request', message: 'Invalid query request' });
14
+ }
15
+ const query = data.query;
16
+ const options = data.options;
17
+ let cancelSubscription;
18
+ if (options.monitor === true) {
19
+ options.monitor = { add: true, change: true, remove: true };
20
+ }
21
+ if (typeof options.monitor === 'object' && (options.monitor.add || options.monitor.change || options.monitor.remove)) {
22
+ const queryId = data.query_id;
23
+ const clientId = data.client_id;
24
+ const client = env.clients.get(clientId);
25
+ client.realtimeQueries[queryId] = { path, query, options };
26
+ const sendEvent = async (event) => {
27
+ try {
28
+ const client = env.clients.get(clientId);
29
+ if (!client) {
30
+ return cancelSubscription?.();
31
+ } // Not connected, stop subscription
32
+ if (!(await env.rules.isOperationAllowed(client.user, event.path, 'get', { context: req.context, value: event.value })).allow) {
33
+ return cancelSubscription?.(); // Access denied, stop subscription
34
+ }
35
+ event.query_id = queryId;
36
+ const data = Transport.serialize(event);
37
+ client.socket.emit('query-event', data);
38
+ }
39
+ catch (err) {
40
+ env.debug.error(`Unexpected error orccured trying to send event`);
41
+ env.debug.error(err);
42
+ }
43
+ };
44
+ options.eventHandler = (event) => {
45
+ sendEvent(event);
46
+ };
47
+ }
48
+ try {
49
+ const { results, context, stop } = await env.db.api.query(path, query, options);
50
+ cancelSubscription = stop;
51
+ if (!env.config.transactions?.log) {
52
+ delete context.acebase_cursor;
53
+ }
54
+ const response = {
55
+ count: results.length,
56
+ list: results, // []
57
+ };
58
+ res.setHeader('AceBase-Context', JSON.stringify(context));
59
+ res.send(Transport.serialize(response));
60
+ }
61
+ catch (err) {
62
+ sendError(res, { code: 'unknown', message: err.message });
63
+ }
64
+ });
65
+ };
66
+ export default addRoute;
57
67
  //# sourceMappingURL=data-query.js.map
@@ -1,73 +1,84 @@
1
- import { PathInfo } from 'acebase-core';
2
- import { sendUnauthorizedError } from '../shared/error.js';
3
- export const addRoute = (env) => {
4
- env.app.get(`/reflect/${env.db.name}/*`, async (req, res) => {
5
- // Reflection API
6
- const path = req.path.slice(env.db.name.length + 10);
7
- const access = env.rules.userHasAccess(req.user, path, false);
8
- if (!access.allow) {
9
- return sendUnauthorizedError(res, access.code, access.message);
10
- }
11
- const impersonatedAccess = {
12
- uid: req.user?.uid !== 'admin' ? null : req.query.impersonate,
13
- read: {
14
- allow: false,
15
- error: null,
16
- },
17
- write: {
18
- allow: false,
19
- error: null,
20
- },
21
- };
22
- const impersonatedUser = impersonatedAccess.uid === 'anonymous' ? null : { uid: impersonatedAccess.uid };
23
- if (impersonatedAccess.uid) {
24
- const readAccess = env.rules.userHasAccess(impersonatedUser, path, false);
25
- impersonatedAccess.read.allow = readAccess.allow;
26
- if (!readAccess.allow) {
27
- impersonatedAccess.read.error = { code: readAccess.code, message: readAccess.message };
28
- }
29
- const writeAccess = env.rules.userHasAccess(impersonatedUser, path, true);
30
- impersonatedAccess.write.allow = writeAccess.allow;
31
- if (!writeAccess.allow) {
32
- impersonatedAccess.write.error = { code: writeAccess.code, message: writeAccess.message };
33
- }
34
- }
35
- const type = req.query.type;
36
- const args = {};
37
- Object.keys(req.query).forEach(key => {
38
- if (!['type', 'impersonate'].includes(key)) {
39
- let val = req.query[key];
40
- if (/^(?:true|false|[0-9]+)$/.test(val)) {
41
- val = JSON.parse(val);
42
- }
43
- args[key] = val;
44
- }
45
- });
46
- try {
47
- const result = await env.db.ref(path).reflect(type, args);
48
- if (impersonatedAccess.uid) {
49
- result.impersonation = impersonatedAccess;
50
- let list;
51
- if (type === 'children') {
52
- list = result.list;
53
- }
54
- else if (type === 'info') {
55
- list = typeof result.children === 'object' && 'list' in result.children ? result.children.list : [];
56
- }
57
- list && list.forEach(childInfo => {
58
- childInfo.access = {
59
- read: env.rules.userHasAccess(impersonatedUser, PathInfo.getChildPath(path, childInfo.key), false).allow,
60
- write: env.rules.userHasAccess(impersonatedUser, PathInfo.getChildPath(path, childInfo.key), true).allow,
61
- };
62
- });
63
- }
64
- res.send(result);
65
- }
66
- catch (err) {
67
- res.statusCode = 500;
68
- res.send(err);
69
- }
70
- });
71
- };
72
- export default addRoute;
1
+ import { PathInfo } from 'acebase-core';
2
+ import { sendUnauthorizedError } from '../shared/error.js';
3
+ export const addRoute = (env) => {
4
+ env.router.get(`/reflect/${env.db.name}/*`, async (req, res) => {
5
+ // Reflection API
6
+ const path = req.path.slice(env.db.name.length + 10);
7
+ const access = await env.rules.isOperationAllowed(req.user, path, 'reflect', { context: req.context, type: req.query.type });
8
+ if (!access.allow) {
9
+ return sendUnauthorizedError(res, access.code, access.message);
10
+ }
11
+ const impersonatedAccess = {
12
+ uid: req.user?.uid !== 'admin' ? null : req.query.impersonate,
13
+ /**
14
+ * NEW, check all possible operations
15
+ */
16
+ operations: {},
17
+ /** Result of `get` operation */
18
+ read: {
19
+ allow: false,
20
+ error: null,
21
+ },
22
+ /** Result of `set` operation */
23
+ write: {
24
+ allow: false,
25
+ error: null,
26
+ },
27
+ };
28
+ const impersonatedUser = impersonatedAccess.uid === 'anonymous' ? null : { uid: impersonatedAccess.uid };
29
+ const impersonatedData = { context: { acebase_reflect: true }, value: '[[reflect]]' }; // TODO: Make configurable
30
+ if (impersonatedAccess.uid) {
31
+ for (const operation of ['transact', 'get', 'update', 'set', 'delete', 'reflect', 'exists', 'query', 'import', 'export']) {
32
+ const access = await env.rules.isOperationAllowed(impersonatedUser, path, operation, impersonatedData);
33
+ impersonatedAccess.operations[operation] = access;
34
+ }
35
+ const readAccess = await env.rules.isOperationAllowed(impersonatedUser, path, 'get'); // Use pre-flight 'get' check to mimic legacy 'read' check
36
+ impersonatedAccess.read.allow = readAccess.allow;
37
+ if (!readAccess.allow) {
38
+ impersonatedAccess.read.error = { code: readAccess.code, message: readAccess.message };
39
+ }
40
+ const writeAccess = await env.rules.isOperationAllowed(impersonatedUser, path, 'update'); // Use pre-flight 'update' check to mimic legacy 'write' check
41
+ impersonatedAccess.write.allow = writeAccess.allow;
42
+ if (!writeAccess.allow) {
43
+ impersonatedAccess.write.error = { code: writeAccess.code, message: writeAccess.message };
44
+ }
45
+ }
46
+ const type = req.query.type;
47
+ const args = {};
48
+ Object.keys(req.query).forEach(key => {
49
+ if (!['type', 'impersonate'].includes(key)) {
50
+ let val = req.query[key];
51
+ if (/^(?:true|false|[0-9]+)$/.test(val)) {
52
+ val = JSON.parse(val);
53
+ }
54
+ args[key] = val;
55
+ }
56
+ });
57
+ try {
58
+ const result = await env.db.ref(path).reflect(type, args);
59
+ if (impersonatedAccess.uid) {
60
+ result.impersonation = impersonatedAccess;
61
+ let list;
62
+ if (type === 'children') {
63
+ list = result.list;
64
+ }
65
+ else if (type === 'info') {
66
+ list = typeof result.children === 'object' && 'list' in result.children ? result.children.list : [];
67
+ }
68
+ for (const childInfo of list ?? []) {
69
+ childInfo.access = {
70
+ read: (await env.rules.isOperationAllowed(impersonatedUser, PathInfo.getChildPath(path, childInfo.key), 'get')).allow,
71
+ write: (await env.rules.isOperationAllowed(impersonatedUser, PathInfo.getChildPath(path, childInfo.key), 'update')).allow, // Use pre-flight 'update' check to mimic legacy 'write' check
72
+ };
73
+ }
74
+ }
75
+ res.send(result);
76
+ }
77
+ catch (err) {
78
+ res.statusCode = 500;
79
+ res.send(err);
80
+ }
81
+ });
82
+ };
83
+ export default addRoute;
73
84
  //# sourceMappingURL=data-reflect.js.map