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,25 +1,25 @@
1
- import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
- import { AceBaseUser } from '../schema/user';
3
- export declare type RequestQuery = never;
4
- export declare type RequestBody = {
5
- client_id?: string;
6
- } & ({
7
- method: 'token';
8
- access_token: string;
9
- } | {
10
- method: 'email';
11
- email: string;
12
- password: string;
13
- } | {
14
- method: 'account';
15
- username: string;
16
- password: string;
17
- });
18
- export declare type ResponseBody = {
19
- access_token: string;
20
- user: AceBaseUser;
21
- };
22
- export declare type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
23
- export declare const addRoute: (env: RouteInitEnvironment) => void;
24
- export default addRoute;
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+ import { AceBaseUser } from '../schema/user';
3
+ export type RequestQuery = never;
4
+ export type RequestBody = {
5
+ client_id?: string;
6
+ } & ({
7
+ method: 'token';
8
+ access_token: string;
9
+ } | {
10
+ method: 'email';
11
+ email: string;
12
+ password: string;
13
+ } | {
14
+ method: 'account';
15
+ username: string;
16
+ password: string;
17
+ });
18
+ export type ResponseBody = {
19
+ access_token: string;
20
+ user: AceBaseUser;
21
+ };
22
+ export type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
23
+ export declare const addRoute: (env: RouteInitEnvironment) => void;
24
+ export default addRoute;
25
25
  //# sourceMappingURL=auth-signin.d.ts.map
@@ -1,15 +1,15 @@
1
- import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
- export declare type RequestQuery = never;
3
- export declare type RequestBody = {
4
- client_id?: string;
5
- } & {
6
- everywhere: boolean;
7
- };
8
- export declare type ResponseBody = 'Bye!' | {
9
- code: string;
10
- message: string;
11
- };
12
- export declare type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
13
- export declare const addRoute: (env: RouteInitEnvironment) => void;
14
- export default addRoute;
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+ export type RequestQuery = never;
3
+ export type RequestBody = {
4
+ client_id?: string;
5
+ } & {
6
+ everywhere: boolean;
7
+ };
8
+ export type ResponseBody = 'Bye!' | {
9
+ code: string;
10
+ message: string;
11
+ };
12
+ export type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
13
+ export declare const addRoute: (env: RouteInitEnvironment) => void;
14
+ export default addRoute;
15
15
  //# sourceMappingURL=auth-signout.d.ts.map
@@ -1,33 +1,33 @@
1
- import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
- import { AceBaseUser, UserProfilePicture } from '../schema/user';
3
- export declare class SignupError extends Error {
4
- code: 'admin_only' | 'conflict' | 'email_conflict' | 'username_conflict' | 'missing_details' | 'invalid_email' | 'invalid_username' | 'invalid_display_name' | 'invalid_password' | 'invalid_picture' | 'invalid_settings';
5
- constructor(code: 'admin_only' | 'conflict' | 'email_conflict' | 'username_conflict' | 'missing_details' | 'invalid_email' | 'invalid_username' | 'invalid_display_name' | 'invalid_password' | 'invalid_picture' | 'invalid_settings', message: string);
6
- }
7
- export declare type RequestQuery = never;
8
- export declare type RequestBody = {
9
- username: string;
10
- email: string;
11
- password: string;
12
- displayName?: string;
13
- display_name?: string;
14
- picture?: UserProfilePicture;
15
- settings: {
16
- [name: string]: string | number | boolean;
17
- };
18
- } & ({
19
- displayName: string;
20
- } | {
21
- display_name: string;
22
- });
23
- export declare type ResponseBody = {
24
- access_token: string;
25
- user: AceBaseUser;
26
- } | {
27
- code: SignupError['code'];
28
- message: string;
29
- };
30
- export declare type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
31
- export declare const addRoute: (env: RouteInitEnvironment) => void;
32
- export default addRoute;
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+ import { AceBaseUser, UserProfilePicture } from '../schema/user';
3
+ export declare class SignupError extends Error {
4
+ code: 'admin_only' | 'conflict' | 'email_conflict' | 'username_conflict' | 'missing_details' | 'invalid_email' | 'invalid_username' | 'invalid_display_name' | 'invalid_password' | 'invalid_picture' | 'invalid_settings';
5
+ constructor(code: 'admin_only' | 'conflict' | 'email_conflict' | 'username_conflict' | 'missing_details' | 'invalid_email' | 'invalid_username' | 'invalid_display_name' | 'invalid_password' | 'invalid_picture' | 'invalid_settings', message: string);
6
+ }
7
+ export type RequestQuery = never;
8
+ export type RequestBody = {
9
+ username: string;
10
+ email: string;
11
+ password: string;
12
+ displayName?: string;
13
+ display_name?: string;
14
+ picture?: UserProfilePicture;
15
+ settings: {
16
+ [name: string]: string | number | boolean;
17
+ };
18
+ } & ({
19
+ displayName: string;
20
+ } | {
21
+ display_name: string;
22
+ });
23
+ export type ResponseBody = {
24
+ access_token: string;
25
+ user: AceBaseUser;
26
+ } | {
27
+ code: SignupError['code'];
28
+ message: string;
29
+ };
30
+ export type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
31
+ export declare const addRoute: (env: RouteInitEnvironment) => void;
32
+ export default addRoute;
33
33
  //# sourceMappingURL=auth-signup.d.ts.map
@@ -1,14 +1,14 @@
1
- import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
- import { AceBaseUser } from '../schema/user';
3
- export declare type RequestQuery = never;
4
- export declare type RequestBody = never;
5
- export declare type ResponseBody = {
6
- signed_in: false;
7
- } | {
8
- signed_in: true;
9
- user: AceBaseUser;
10
- };
11
- export declare type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
12
- export declare const addRoute: (env: RouteInitEnvironment) => void;
13
- export default addRoute;
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+ import { AceBaseUser } from '../schema/user';
3
+ export type RequestQuery = never;
4
+ export type RequestBody = never;
5
+ export type ResponseBody = {
6
+ signed_in: false;
7
+ } | {
8
+ signed_in: true;
9
+ user: AceBaseUser;
10
+ };
11
+ export type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
12
+ export declare const addRoute: (env: RouteInitEnvironment) => void;
13
+ export default addRoute;
14
14
  //# sourceMappingURL=auth-state.d.ts.map
@@ -1,34 +1,34 @@
1
- import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
- import { AceBaseUser, UserProfilePicture } from '../schema/user';
3
- export declare class UpdateError extends Error {
4
- code: 'unauthenticated_update' | 'unauthorized_update' | 'user_not_found' | 'invalid_email' | 'email_conflict' | 'invalid_username' | 'username_conflict' | 'invalid_display_name' | 'invalid_picture' | 'invalid_settings';
5
- constructor(code: 'unauthenticated_update' | 'unauthorized_update' | 'user_not_found' | 'invalid_email' | 'email_conflict' | 'invalid_username' | 'username_conflict' | 'invalid_display_name' | 'invalid_picture' | 'invalid_settings', message: string);
6
- }
7
- export declare type RequestQuery = never;
8
- export declare type RequestBody = {
9
- /** admin only: specifies user account to update */
10
- uid: string;
11
- /** Admin only: whether to enable or disable the account */
12
- is_disabled?: boolean;
13
- email?: string;
14
- username?: string;
15
- displayName?: string;
16
- display_name?: string;
17
- picture?: UserProfilePicture;
18
- settings?: {
19
- [name: string]: string | number | boolean;
20
- };
21
- } & ({
22
- displayName: string;
23
- } | {
24
- display_name: string;
25
- });
26
- export declare type ResponseBody = {
27
- user: AceBaseUser;
28
- } | {
29
- code: UpdateError['code'];
30
- message: string;
31
- };
32
- export declare type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
33
- export declare const addRoute: (env: RouteInitEnvironment) => void;
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+ import { AceBaseUser, UserProfilePicture } from '../schema/user';
3
+ export declare class UpdateError extends Error {
4
+ code: 'unauthenticated_update' | 'unauthorized_update' | 'user_not_found' | 'invalid_email' | 'email_conflict' | 'invalid_username' | 'username_conflict' | 'invalid_display_name' | 'invalid_picture' | 'invalid_settings';
5
+ constructor(code: 'unauthenticated_update' | 'unauthorized_update' | 'user_not_found' | 'invalid_email' | 'email_conflict' | 'invalid_username' | 'username_conflict' | 'invalid_display_name' | 'invalid_picture' | 'invalid_settings', message: string);
6
+ }
7
+ export type RequestQuery = never;
8
+ export type RequestBody = {
9
+ /** admin only: specifies user account to update */
10
+ uid: string;
11
+ /** Admin only: whether to enable or disable the account */
12
+ is_disabled?: boolean;
13
+ email?: string;
14
+ username?: string;
15
+ displayName?: string;
16
+ display_name?: string;
17
+ picture?: UserProfilePicture;
18
+ settings?: {
19
+ [name: string]: string | number | boolean;
20
+ };
21
+ } & ({
22
+ displayName: string;
23
+ } | {
24
+ display_name: string;
25
+ });
26
+ export type ResponseBody = {
27
+ user: AceBaseUser;
28
+ } | {
29
+ code: UpdateError['code'];
30
+ message: string;
31
+ };
32
+ export type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
33
+ export declare const addRoute: (env: RouteInitEnvironment) => void;
34
34
  //# sourceMappingURL=auth-update.d.ts.map
@@ -1,22 +1,22 @@
1
- import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
- export declare class VerifyEmailError extends Error {
3
- code: 'invalid_code' | 'unknown_user';
4
- constructor(code: 'invalid_code' | 'unknown_user', message: string);
5
- }
6
- export declare type RequestQuery = never;
7
- export declare type RequestBody = {
8
- code: string;
9
- };
10
- export declare type ResponseBody = 'OK' | {
11
- code: string;
12
- message: string;
13
- };
14
- export declare type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
15
- /**
16
- * Adds the verify_email route and returns the verification function that can be used to manually verify an email address
17
- * @param env environment
18
- * @returns returns the verification function
19
- */
20
- export declare const addRoute: (env: RouteInitEnvironment) => (clientIp: string, code: string) => Promise<void>;
21
- export default addRoute;
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+ export declare class VerifyEmailError extends Error {
3
+ code: 'invalid_code' | 'unknown_user';
4
+ constructor(code: 'invalid_code' | 'unknown_user', message: string);
5
+ }
6
+ export type RequestQuery = never;
7
+ export type RequestBody = {
8
+ code: string;
9
+ };
10
+ export type ResponseBody = 'OK' | {
11
+ code: string;
12
+ message: string;
13
+ };
14
+ export type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
15
+ /**
16
+ * Adds the verify_email route and returns the verification function that can be used to manually verify an email address
17
+ * @param env environment
18
+ * @returns returns the verification function
19
+ */
20
+ export declare const addRoute: (env: RouteInitEnvironment) => (clientIp: string, code: string) => Promise<void>;
21
+ export default addRoute;
22
22
  //# sourceMappingURL=auth-verify-email.d.ts.map
@@ -1,7 +1,7 @@
1
- import { RouteInitEnvironment } from '../shared/env';
2
- export declare const addAuthenticionRoutes: (env: RouteInitEnvironment) => {
3
- verifyEmailAddress: (clientIp: string, code: string) => Promise<void>;
4
- resetPassword: (clientIp: string, code: string, newPassword: string) => Promise<import("../schema/user").DbUserAccountDetails>;
5
- };
6
- export default addAuthenticionRoutes;
1
+ import { RouteInitEnvironment } from '../shared/env';
2
+ export declare const addAuthenticionRoutes: (env: RouteInitEnvironment) => {
3
+ verifyEmailAddress: (clientIp: string, code: string) => Promise<void>;
4
+ resetPassword: (clientIp: string, code: string, newPassword: string) => Promise<import("../schema/user").DbUserAccountDetails>;
5
+ };
6
+ export default addAuthenticionRoutes;
7
7
  //# sourceMappingURL=auth.d.ts.map
@@ -1,10 +1,10 @@
1
- import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
- export declare type RequestQuery = null;
3
- export declare type RequestBody = null;
4
- export declare type ResponseBody = {
5
- exists: boolean;
6
- };
7
- export declare type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
8
- export declare const addRoute: (env: RouteInitEnvironment) => void;
9
- export default addRoute;
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+ export type RequestQuery = null;
3
+ export type RequestBody = null;
4
+ export type ResponseBody = {
5
+ exists: boolean;
6
+ };
7
+ export type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
8
+ export declare const addRoute: (env: RouteInitEnvironment) => void;
9
+ export default addRoute;
10
10
  //# sourceMappingURL=data-exists.d.ts.map
@@ -1,11 +1,11 @@
1
- import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
- export declare type RequestQuery = {
3
- format?: 'json';
4
- type_safe?: '0' | '1';
5
- };
6
- export declare type RequestBody = null;
7
- export declare type ResponseBody = any;
8
- export declare type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
9
- export declare const addRoute: (env: RouteInitEnvironment) => void;
10
- export default addRoute;
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+ export type RequestQuery = {
3
+ format?: 'json';
4
+ type_safe?: '0' | '1';
5
+ };
6
+ export type RequestBody = null;
7
+ export type ResponseBody = any;
8
+ export type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
9
+ export declare const addRoute: (env: RouteInitEnvironment) => void;
10
+ export default addRoute;
11
11
  //# sourceMappingURL=data-export.d.ts.map
@@ -1,15 +1,15 @@
1
- import { Transport } from 'acebase-core';
2
- import { RouteInitEnvironment, RouteRequest } from '../shared/env';
3
- export declare type RequestQuery = {
4
- include?: string;
5
- exclude?: string;
6
- child_objects?: boolean;
7
- };
8
- export declare type RequestBody = null;
9
- export declare type ResponseBody = Transport.SerializedValue & {
10
- exists: boolean;
11
- };
12
- export declare type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
13
- export declare const addRoute: (env: RouteInitEnvironment) => void;
14
- export default addRoute;
1
+ import { Transport } from 'acebase-core';
2
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
3
+ export type RequestQuery = {
4
+ include?: string;
5
+ exclude?: string;
6
+ child_objects?: boolean;
7
+ };
8
+ export type RequestBody = null;
9
+ export type ResponseBody = Transport.SerializedValue & {
10
+ exists: boolean;
11
+ };
12
+ export type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
13
+ export declare const addRoute: (env: RouteInitEnvironment) => void;
14
+ export default addRoute;
15
15
  //# sourceMappingURL=data-get.d.ts.map
@@ -1,14 +1,14 @@
1
- import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
- export declare type RequestQuery = {
3
- format?: 'json';
4
- suppress_events?: '0' | '1';
5
- };
6
- export declare type RequestBody = null;
7
- export declare type ResponseBody = {
8
- success: boolean;
9
- reason?: string;
10
- };
11
- export declare type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
12
- export declare const addRoute: (env: RouteInitEnvironment) => void;
13
- export default addRoute;
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+ export type RequestQuery = {
3
+ format?: 'json';
4
+ suppress_events?: '0' | '1';
5
+ };
6
+ export type RequestBody = null;
7
+ export type ResponseBody = {
8
+ success: boolean;
9
+ reason?: string;
10
+ };
11
+ export type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
12
+ export declare const addRoute: (env: RouteInitEnvironment) => void;
13
+ export default addRoute;
14
14
  //# sourceMappingURL=data-import.d.ts.map
@@ -1,52 +1,52 @@
1
- import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
- export declare type FullTextIndexOptions = {
3
- type: 'fulltext';
4
- config?: {
5
- /** Callback function that transforms (and/or filters) words being indexed _and_ queried */
6
- transform?: (locale: string, word: string) => string;
7
- /** Also known as a stoplist. Array of words to automatically be ignored for indexing and querying. */
8
- blacklist?: string[];
9
- /** Words to be included if they did not match minLength and/or blacklist criteria */
10
- whitelist?: string[];
11
- /** Only use words with a minimum length */
12
- minLength?: number;
13
- /** Only use words with a maximum length */
14
- maxLength?: number;
15
- /** Specify a key in the data that contains the locale of the indexed texts. This allows multiple languages to be indexed using their own rules. */
16
- localeKey?: string;
17
- /** Boolean value that specifies whether a default stoplist for the used locale should be used to automatically blacklist words. Currently only available for locale "en", which contains very frequently used words like "a", "i", "me", "it", "the", "they", "them" etc. */
18
- useStoplist?: boolean;
19
- };
20
- };
21
- export declare type GeoIndexOptions = {
22
- type: 'geo';
23
- };
24
- export declare type ArrayIndexOptions = {
25
- type: 'array';
26
- };
27
- export declare type CreateIndexRequest = {
28
- path: string;
29
- key: string;
30
- options?: {
31
- type?: 'normal' | 'array' | 'fulltext' | 'geo';
32
- rebuild?: boolean;
33
- textLocale?: string;
34
- include?: string[];
35
- config?: object;
36
- } & ({} | FullTextIndexOptions | GeoIndexOptions | ArrayIndexOptions);
37
- };
38
- export declare type RequestQuery = null;
39
- export declare type RequestBody = CreateIndexRequest;
40
- export declare type ResponseBody = {
41
- success: true;
42
- } | {
43
- code: 'admin_only';
44
- message: string;
45
- } | {
46
- code: 'unexpected';
47
- message: string;
48
- };
49
- export declare type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
50
- export declare const addRoute: (env: RouteInitEnvironment) => void;
51
- export default addRoute;
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+ export type FullTextIndexOptions = {
3
+ type: 'fulltext';
4
+ config?: {
5
+ /** Callback function that transforms (and/or filters) words being indexed _and_ queried */
6
+ transform?: (locale: string, word: string) => string;
7
+ /** Also known as a stoplist. Array of words to automatically be ignored for indexing and querying. */
8
+ blacklist?: string[];
9
+ /** Words to be included if they did not match minLength and/or blacklist criteria */
10
+ whitelist?: string[];
11
+ /** Only use words with a minimum length */
12
+ minLength?: number;
13
+ /** Only use words with a maximum length */
14
+ maxLength?: number;
15
+ /** Specify a key in the data that contains the locale of the indexed texts. This allows multiple languages to be indexed using their own rules. */
16
+ localeKey?: string;
17
+ /** Boolean value that specifies whether a default stoplist for the used locale should be used to automatically blacklist words. Currently only available for locale "en", which contains very frequently used words like "a", "i", "me", "it", "the", "they", "them" etc. */
18
+ useStoplist?: boolean;
19
+ };
20
+ };
21
+ export type GeoIndexOptions = {
22
+ type: 'geo';
23
+ };
24
+ export type ArrayIndexOptions = {
25
+ type: 'array';
26
+ };
27
+ export type CreateIndexRequest = {
28
+ path: string;
29
+ key: string;
30
+ options?: {
31
+ type?: 'normal' | 'array' | 'fulltext' | 'geo';
32
+ rebuild?: boolean;
33
+ textLocale?: string;
34
+ include?: string[];
35
+ config?: object;
36
+ } & ({} | FullTextIndexOptions | GeoIndexOptions | ArrayIndexOptions);
37
+ };
38
+ export type RequestQuery = null;
39
+ export type RequestBody = CreateIndexRequest;
40
+ export type ResponseBody = {
41
+ success: true;
42
+ } | {
43
+ code: 'admin_only';
44
+ message: string;
45
+ } | {
46
+ code: 'unexpected';
47
+ message: string;
48
+ };
49
+ export type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
50
+ export declare const addRoute: (env: RouteInitEnvironment) => void;
51
+ export default addRoute;
52
52
  //# sourceMappingURL=data-index-create.d.ts.map
@@ -1,18 +1,18 @@
1
- import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
- export declare type RequestQuery = null;
3
- export declare type RequestBody = {
4
- fileName: string;
5
- };
6
- export declare type ResponseBody = {
7
- success: true;
8
- } | {
9
- code: 'admin_only';
10
- message: string;
11
- } | {
12
- code: 'unexpected';
13
- message: string;
14
- };
15
- export declare type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
16
- export declare const addRoute: (env: RouteInitEnvironment) => void;
17
- export default addRoute;
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+ export type RequestQuery = null;
3
+ export type RequestBody = {
4
+ fileName: string;
5
+ };
6
+ export type ResponseBody = {
7
+ success: true;
8
+ } | {
9
+ code: 'admin_only';
10
+ message: string;
11
+ } | {
12
+ code: 'unexpected';
13
+ message: string;
14
+ };
15
+ export type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
16
+ export declare const addRoute: (env: RouteInitEnvironment) => void;
17
+ export default addRoute;
18
18
  //# sourceMappingURL=data-index-delete.d.ts.map
@@ -1,22 +1,22 @@
1
- import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
- export interface PublicDataIndex {
3
- path: string;
4
- key: string;
5
- caseSensitive: boolean;
6
- textLocale: string;
7
- includeKeys: string[];
8
- indexMetadataKeys: string[];
9
- type: 'normal' | 'array' | 'fulltext' | 'geo';
10
- fileName: string;
11
- description: string;
12
- }
13
- export declare type RequestQuery = null;
14
- export declare type RequestBody = null;
15
- export declare type ResponseBody = PublicDataIndex[] | {
16
- code: string;
17
- message: string;
18
- };
19
- export declare type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
20
- export declare const addRoute: (env: RouteInitEnvironment) => void;
21
- export default addRoute;
1
+ import { RouteInitEnvironment, RouteRequest } from '../shared/env';
2
+ export interface PublicDataIndex {
3
+ path: string;
4
+ key: string;
5
+ caseSensitive: boolean;
6
+ textLocale: string;
7
+ includeKeys: string[];
8
+ indexMetadataKeys: string[];
9
+ type: 'normal' | 'array' | 'fulltext' | 'geo';
10
+ fileName: string;
11
+ description: string;
12
+ }
13
+ export type RequestQuery = null;
14
+ export type RequestBody = null;
15
+ export type ResponseBody = PublicDataIndex[] | {
16
+ code: string;
17
+ message: string;
18
+ };
19
+ export type Request = RouteRequest<RequestQuery, RequestBody, ResponseBody>;
20
+ export declare const addRoute: (env: RouteInitEnvironment) => void;
21
+ export default addRoute;
22
22
  //# sourceMappingURL=data-index-list.d.ts.map