acebase-server 1.16.1 → 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 -78
  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 -71
  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 -23
  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,112 +1,118 @@
1
- import { DebugLogger, SimpleEventEmitter } from 'acebase-core';
2
- import { AceBaseServerSettings, AceBaseServerConfig } from './settings';
3
- import { createApp, HttpRequest, HttpResponse } from './shared/http';
4
- import { AceBase } from 'acebase';
5
- import { OAuth2Provider } from './oauth-providers/oauth-provider';
6
- import { DbUserAccountDetails } from './schema/user';
7
- export declare class AceBaseServerNotReadyError extends Error {
8
- constructor();
9
- }
10
- export declare class AceBaseExternalServerError extends Error {
11
- constructor();
12
- }
13
- declare type HttpMethod = 'get' | 'GET' | 'put' | 'PUT' | 'post' | 'POST' | 'delete' | 'DELETE';
14
- export declare class AceBaseServer extends SimpleEventEmitter {
15
- private _ready;
16
- get isReady(): boolean;
17
- /**
18
- * Wait for the server to be ready to accept incoming connections
19
- * @param callback (optional) callback function that is called when ready. You can also use the returned promise
20
- * @returns returns a promise that resolves when ready
21
- */
22
- ready(callback?: () => any): Promise<void>;
23
- /**
24
- * Gets the active server configuration
25
- */
26
- readonly config: AceBaseServerConfig;
27
- /**
28
- * Gets the url the server is running at
29
- */
30
- get url(): string;
31
- readonly debug: DebugLogger;
32
- /**
33
- * Gets direct access to the database, this bypasses any security rules and schema validators.
34
- * You can use this to add custom event handlers ("cloud functions") to your database directly.
35
- * NOTE: your code will run in the same thread as the server, make sure you are not performing
36
- * CPU heavy tasks here. If you have to do heavy weightlifting, create a seperate app that connects
37
- * to your server with an AceBaseClient, or execute in a worker thread.
38
- * @example
39
- * server.db.ref('uploads/images').on('child_added', async snap => {
40
- * const image = snap.val();
41
- * const resizedImages = await createImageSizes(image); // Some function that creates multiple image sizes in worker thread
42
- * const targetRef = await server.db.ref('images').push(resizedImages); // Store them somewhere else
43
- * await snap.ref.remove(); // Remove original upload
44
- * });
45
- */
46
- readonly db: AceBase;
47
- /**
48
- * Exposes the used http frameworks app (currently Express) for external use.
49
- */
50
- readonly app: ReturnType<typeof createApp>;
51
- private readonly authProviders;
52
- constructor(dbname: string, options?: AceBaseServerSettings);
53
- private init;
54
- /**
55
- * Reset a user's password. This can also be done using the auth/reset_password API endpoint
56
- * @param clientIp ip address of the user
57
- * @param code reset code that was sent to the user's email address
58
- * @param newPassword new password chosen by the user
59
- */
60
- resetPassword(clientIp: string, code: string, newPassword: string): Promise<DbUserAccountDetails>;
61
- /**
62
- * Marks a user account's email address as validated. This can also be done using the auth/verify_email API endpoint
63
- * @param clientIp ip address of the user
64
- * @param code verification code sent to the user's email address
65
- */
66
- verifyEmailAddress(clientIp: string, code: string): Promise<void>;
67
- /**
68
- * Shuts down the server. Stops listening for incoming connections, breaks current connections and closes the database.
69
- * Is automatically executed when a "SIGINT" process event is received.
70
- *
71
- * Once the shutdown procedure is completed, it emits a "shutdown" event on the server instance, "acebase-server-shutdown" event on the `process`, and sends an 'acebase-server-shutdown' IPC message if Node.js clustering is used.
72
- * These events can be handled by cluster managing code to `kill` or `exit` the process safely.
73
- */
74
- shutdown(): void;
75
- /**
76
- * Temporarily stops the server from handling incoming connections, but keeps existing connections open
77
- */
78
- pause(): Promise<void>;
79
- /**
80
- * Resumes handling incoming connections
81
- */
82
- resume(): Promise<void>;
83
- /**
84
- * Extend the server API with your own custom functions. Your handler will be listening
85
- * on path /ext/[db name]/[ext_path].
86
- * @example
87
- * // Server side:
88
- * const _quotes = [...];
89
- * server.extend('get', 'quotes/random', (req, res) => {
90
- * let index = Math.round(Math.random() * _quotes.length);
91
- * res.send(quotes[index]);
92
- * })
93
- * // Client side:
94
- * client.callExtension('get', 'quotes/random')
95
- * .then(quote => {
96
- * console.log(`Got random quote: ${quote}`);
97
- * })
98
- * @param method http method to bind to
99
- * @param ext_path path to bind to (appended to /ext/)
100
- * @param handler your Express request handler callback
101
- */
102
- extend(method: HttpMethod, ext_path: string, handler: (req: HttpRequest, res: HttpResponse) => void): void;
103
- /**
104
- * Configure an auth provider to allow users to sign in with Facebook, Google, etc
105
- * @param providerName name of the third party OAuth provider. Eg: "Facebook", "Google", "spotify" etc
106
- * @param settings API key & secret for the OAuth provider
107
- * @returns Returns the created auth provider instance, which can be used to call non-user specific methods the provider might support. (example: the Spotify auth provider supports getClientAuthToken, which allows API calls to be made to the core (non-user) spotify service)
108
- */
109
- configAuthProvider(providerName: string, settings: any): OAuth2Provider;
110
- }
111
- export {};
1
+ import { DebugLogger, SimpleEventEmitter } from 'acebase-core';
2
+ import { AceBaseServerSettings, AceBaseServerConfig } from './settings';
3
+ import { HttpApp, HttpRequest, HttpResponse, HttpRouter } from './shared/http';
4
+ import { AceBase } from 'acebase';
5
+ import { OAuth2Provider } from './oauth-providers/oauth-provider';
6
+ import { PathRuleFunction, PathRuleType } from './rules';
7
+ import { DbUserAccountDetails } from './schema/user';
8
+ export declare class AceBaseServerNotReadyError extends Error {
9
+ constructor();
10
+ }
11
+ export declare class AceBaseExternalServerError extends Error {
12
+ constructor();
13
+ }
14
+ type HttpMethod = 'get' | 'GET' | 'put' | 'PUT' | 'post' | 'POST' | 'delete' | 'DELETE';
15
+ export declare class AceBaseServer extends SimpleEventEmitter {
16
+ private _ready;
17
+ get isReady(): boolean;
18
+ /**
19
+ * Wait for the server to be ready to accept incoming connections
20
+ * @param callback (optional) callback function that is called when ready. You can also use the returned promise
21
+ * @returns returns a promise that resolves when ready
22
+ */
23
+ ready(callback?: () => any): Promise<void>;
24
+ /**
25
+ * Gets the active server configuration
26
+ */
27
+ readonly config: AceBaseServerConfig;
28
+ /**
29
+ * Gets the url the server is running at
30
+ */
31
+ get url(): string;
32
+ readonly debug: DebugLogger;
33
+ /**
34
+ * Gets direct access to the database, this bypasses any security rules and schema validators.
35
+ * You can use this to add custom event handlers ("cloud functions") to your database directly.
36
+ * NOTE: your code will run in the same thread as the server, make sure you are not performing
37
+ * CPU heavy tasks here. If you have to do heavy weightlifting, create a seperate app that connects
38
+ * to your server with an AceBaseClient, or execute in a worker thread.
39
+ * @example
40
+ * server.db.ref('uploads/images').on('child_added', async snap => {
41
+ * const image = snap.val();
42
+ * const resizedImages = await createImageSizes(image); // Some function that creates multiple image sizes in worker thread
43
+ * const targetRef = await server.db.ref('images').push(resizedImages); // Store them somewhere else
44
+ * await snap.ref.remove(); // Remove original upload
45
+ * });
46
+ */
47
+ readonly db: AceBase;
48
+ /**
49
+ * Exposes the used http frameworks router (currently Express) for external use.
50
+ */
51
+ readonly router: HttpRouter;
52
+ /**
53
+ * Exposes the used http frameworks app (currently Express) for external use.
54
+ */
55
+ readonly app: HttpApp;
56
+ private readonly authProviders;
57
+ constructor(dbname: string, options?: AceBaseServerSettings);
58
+ private init;
59
+ /**
60
+ * Reset a user's password. This can also be done using the auth/reset_password API endpoint
61
+ * @param clientIp ip address of the user
62
+ * @param code reset code that was sent to the user's email address
63
+ * @param newPassword new password chosen by the user
64
+ */
65
+ resetPassword(clientIp: string, code: string, newPassword: string): Promise<DbUserAccountDetails>;
66
+ /**
67
+ * Marks a user account's email address as validated. This can also be done using the auth/verify_email API endpoint
68
+ * @param clientIp ip address of the user
69
+ * @param code verification code sent to the user's email address
70
+ */
71
+ verifyEmailAddress(clientIp: string, code: string): Promise<void>;
72
+ /**
73
+ * Shuts down the server. Stops listening for incoming connections, breaks current connections and closes the database.
74
+ * Is automatically executed when a "SIGINT" process event is received.
75
+ *
76
+ * Once the shutdown procedure is completed, it emits a "shutdown" event on the server instance, "acebase-server-shutdown" event on the `process`, and sends an 'acebase-server-shutdown' IPC message if Node.js clustering is used.
77
+ * These events can be handled by cluster managing code to `kill` or `exit` the process safely.
78
+ */
79
+ shutdown(): void;
80
+ /**
81
+ * Temporarily stops the server from handling incoming connections, but keeps existing connections open
82
+ */
83
+ pause(): Promise<void>;
84
+ /**
85
+ * Resumes handling incoming connections
86
+ */
87
+ resume(): Promise<void>;
88
+ /**
89
+ * Extend the server API with your own custom functions. Your handler will be listening
90
+ * on path /ext/[db name]/[ext_path].
91
+ * @example
92
+ * // Server side:
93
+ * const _quotes = [...];
94
+ * server.extend('get', 'quotes/random', (req, res) => {
95
+ * let index = Math.round(Math.random() * _quotes.length);
96
+ * res.send(quotes[index]);
97
+ * })
98
+ * // Client side:
99
+ * client.callExtension('get', 'quotes/random')
100
+ * .then(quote => {
101
+ * console.log(`Got random quote: ${quote}`);
102
+ * })
103
+ * @param method http method to bind to
104
+ * @param ext_path path to bind to (appended to /ext/)
105
+ * @param handler your Express request handler callback
106
+ */
107
+ extend(method: HttpMethod, ext_path: string, handler: (req: HttpRequest, res: HttpResponse) => void): void;
108
+ /**
109
+ * Configure an auth provider to allow users to sign in with Facebook, Google, etc
110
+ * @param providerName name of the third party OAuth provider. Eg: "Facebook", "Google", "spotify" etc
111
+ * @param settings API key & secret for the OAuth provider
112
+ * @returns Returns the created auth provider instance, which can be used to call non-user specific methods the provider might support. (example: the Spotify auth provider supports getClientAuthToken, which allows API calls to be made to the core (non-user) spotify service)
113
+ */
114
+ configAuthProvider(providerName: string, settings: any): OAuth2Provider;
115
+ setRule(paths: string | string[], types: PathRuleType | PathRuleType[], callback: PathRuleFunction): void;
116
+ }
117
+ export {};
112
118
  //# sourceMappingURL=server.d.ts.map
@@ -1,15 +1,15 @@
1
- import { AceBaseEmailRequest } from '../shared/email';
2
- export interface AceBaseServerEmailServerSettings {
3
- host: string;
4
- port: number;
5
- username?: string;
6
- password?: string;
7
- secure: boolean;
8
- }
9
- export interface AceBaseServerEmailSettings {
10
- /** NOT IMPLEMENTED YET - Use send property for your own implementation */
11
- server?: AceBaseServerEmailServerSettings;
12
- /** function to call when an e-mail needs to be sent */
13
- send: (request: AceBaseEmailRequest) => Promise<void>;
14
- }
1
+ import { AceBaseEmailRequest } from '../shared/email';
2
+ export interface AceBaseServerEmailServerSettings {
3
+ host: string;
4
+ port: number;
5
+ username?: string;
6
+ password?: string;
7
+ secure: boolean;
8
+ }
9
+ export interface AceBaseServerEmailSettings {
10
+ /** NOT IMPLEMENTED YET - Use send property for your own implementation */
11
+ server?: AceBaseServerEmailServerSettings;
12
+ /** function to call when an e-mail needs to be sent */
13
+ send: (request: AceBaseEmailRequest) => Promise<void>;
14
+ }
15
15
  //# sourceMappingURL=email.d.ts.map