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.
- package/README.md +180 -10
- package/bin/acebase-server.js +8 -0
- package/build-vars.js +2 -1
- package/dist/cjs/auth.js +88 -88
- package/dist/cjs/cluster.js +6 -56
- package/dist/cjs/index.d.ts +1 -1
- package/dist/cjs/index.js +24 -24
- package/dist/cjs/logger.js +73 -73
- package/dist/cjs/middleware/404.js +14 -14
- package/dist/cjs/middleware/admin-only.js +28 -28
- package/dist/cjs/middleware/cache.js +14 -14
- package/dist/cjs/middleware/connection.js +49 -49
- package/dist/cjs/middleware/context.js +20 -20
- package/dist/cjs/middleware/cors.js +50 -50
- package/dist/cjs/middleware/swagger.js +17 -17
- package/dist/cjs/middleware/user.js +57 -57
- package/dist/cjs/oauth-providers/dropbox.js +109 -109
- package/dist/cjs/oauth-providers/facebook.js +85 -85
- package/dist/cjs/oauth-providers/google.js +119 -119
- package/dist/cjs/oauth-providers/index.js +26 -26
- package/dist/cjs/oauth-providers/instagram.js +80 -80
- package/dist/cjs/oauth-providers/oauth-provider.js +20 -20
- package/dist/cjs/oauth-providers/spotify.js +113 -113
- package/dist/cjs/routes/auth-change-password.js +87 -87
- package/dist/cjs/routes/auth-delete.js +52 -52
- package/dist/cjs/routes/auth-forgot-password.js +77 -77
- package/dist/cjs/routes/auth-reset-password.js +97 -97
- package/dist/cjs/routes/auth-signin.js +46 -46
- package/dist/cjs/routes/auth-signout.js +61 -61
- package/dist/cjs/routes/auth-signup.js +142 -142
- package/dist/cjs/routes/auth-state.js +25 -25
- package/dist/cjs/routes/auth-update.js +131 -131
- package/dist/cjs/routes/auth-verify-email.js +71 -71
- package/dist/cjs/routes/auth.js +57 -54
- package/dist/cjs/routes/data-exists.js +33 -33
- package/dist/cjs/routes/data-export.js +48 -48
- package/dist/cjs/routes/data-get.js +70 -66
- package/dist/cjs/routes/data-import.js +54 -54
- package/dist/cjs/routes/data-index-create.js +42 -42
- package/dist/cjs/routes/data-index-delete.js +33 -33
- package/dist/cjs/routes/data-index-list.js +31 -31
- package/dist/cjs/routes/data-query.js +80 -70
- package/dist/cjs/routes/data-reflect.js +97 -86
- package/dist/cjs/routes/data-schema-get.js +36 -36
- package/dist/cjs/routes/data-schema-set.js +30 -30
- package/dist/cjs/routes/data-schema-test.js +43 -43
- package/dist/cjs/routes/data-schemas-list.js +32 -32
- package/dist/cjs/routes/data-set.js +85 -75
- package/dist/cjs/routes/data-sync-changes.js +81 -67
- package/dist/cjs/routes/data-sync-mutations.js +81 -67
- package/dist/cjs/routes/data-transaction.js +159 -139
- package/dist/cjs/routes/data-update.js +86 -75
- package/dist/cjs/routes/data.js +62 -62
- package/dist/cjs/routes/docs.js +258 -251
- package/dist/cjs/routes/meta-info.js +63 -63
- package/dist/cjs/routes/meta-logs.js +49 -49
- package/dist/cjs/routes/meta-ping.js +11 -11
- package/dist/cjs/routes/meta-stats.js +27 -27
- package/dist/cjs/routes/meta.js +19 -19
- package/dist/cjs/routes/oauth2-init.js +54 -54
- package/dist/cjs/routes/oauth2-refresh.js +42 -42
- package/dist/cjs/routes/oauth2-signin.js +265 -265
- package/dist/cjs/routes/webmanager.js +26 -26
- package/dist/cjs/rules.js +380 -167
- package/dist/cjs/sandbox.js +28 -0
- package/dist/cjs/schema/user.js +24 -24
- package/dist/cjs/server.js +410 -407
- package/dist/cjs/settings/email.js +2 -2
- package/dist/cjs/settings/index.js +175 -172
- package/dist/cjs/shared/clients.js +26 -26
- package/dist/cjs/shared/email.js +2 -2
- package/dist/cjs/shared/env.js +2 -2
- package/dist/cjs/shared/error.js +33 -33
- package/dist/cjs/shared/http.js +28 -28
- package/dist/cjs/shared/password.js +45 -45
- package/dist/cjs/shared/rootpath.js +16 -16
- package/dist/cjs/shared/signin.js +143 -143
- package/dist/cjs/shared/simple-fetch.js +76 -76
- package/dist/cjs/shared/tokens.js +79 -79
- package/dist/cjs/shared/validate.js +61 -61
- package/dist/cjs/start.js +119 -53
- package/dist/cjs/test.js +10 -10
- package/dist/cjs/websocket/index.js +331 -319
- package/dist/cjs/websocket/manager.js +15 -15
- package/dist/cjs/websocket/socket.io.js +76 -76
- package/dist/esm/auth.js +75 -75
- package/dist/esm/cluster.js +6 -54
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +4 -4
- package/dist/esm/logger.js +51 -51
- package/dist/esm/middleware/404.js +10 -10
- package/dist/esm/middleware/admin-only.js +24 -24
- package/dist/esm/middleware/cache.js +10 -10
- package/dist/esm/middleware/connection.js +45 -45
- package/dist/esm/middleware/context.js +16 -16
- package/dist/esm/middleware/cors.js +44 -44
- package/dist/esm/middleware/swagger.js +13 -13
- package/dist/esm/middleware/user.js +44 -44
- package/dist/esm/oauth-providers/dropbox.js +90 -90
- package/dist/esm/oauth-providers/facebook.js +66 -66
- package/dist/esm/oauth-providers/google.js +96 -96
- package/dist/esm/oauth-providers/index.js +18 -18
- package/dist/esm/oauth-providers/instagram.js +61 -61
- package/dist/esm/oauth-providers/oauth-provider.js +16 -16
- package/dist/esm/oauth-providers/spotify.js +92 -92
- package/dist/esm/routes/auth-change-password.js +72 -72
- package/dist/esm/routes/auth-delete.js +37 -37
- package/dist/esm/routes/auth-forgot-password.js +62 -62
- package/dist/esm/routes/auth-reset-password.js +81 -81
- package/dist/esm/routes/auth-signin.js +33 -33
- package/dist/esm/routes/auth-signout.js +47 -47
- package/dist/esm/routes/auth-signup.js +127 -127
- package/dist/esm/routes/auth-state.js +12 -12
- package/dist/esm/routes/auth-update.js +116 -116
- package/dist/esm/routes/auth-verify-email.js +57 -57
- package/dist/esm/routes/auth.js +53 -50
- package/dist/esm/routes/data-exists.js +20 -20
- package/dist/esm/routes/data-export.js +35 -35
- package/dist/esm/routes/data-get.js +56 -52
- package/dist/esm/routes/data-import.js +41 -41
- package/dist/esm/routes/data-index-create.js +28 -28
- package/dist/esm/routes/data-index-delete.js +20 -20
- package/dist/esm/routes/data-index-list.js +18 -18
- package/dist/esm/routes/data-query.js +66 -56
- package/dist/esm/routes/data-reflect.js +83 -72
- package/dist/esm/routes/data-schema-get.js +23 -23
- package/dist/esm/routes/data-schema-set.js +17 -17
- package/dist/esm/routes/data-schema-test.js +29 -29
- package/dist/esm/routes/data-schemas-list.js +19 -19
- package/dist/esm/routes/data-set.js +70 -60
- package/dist/esm/routes/data-sync-changes.js +67 -53
- package/dist/esm/routes/data-sync-mutations.js +67 -53
- package/dist/esm/routes/data-transaction.js +142 -123
- package/dist/esm/routes/data-update.js +71 -60
- package/dist/esm/routes/data.js +58 -58
- package/dist/esm/routes/docs.js +252 -245
- package/dist/esm/routes/meta-info.js +59 -59
- package/dist/esm/routes/meta-logs.js +35 -35
- package/dist/esm/routes/meta-ping.js +7 -7
- package/dist/esm/routes/meta-stats.js +14 -14
- package/dist/esm/routes/meta.js +15 -15
- package/dist/esm/routes/oauth2-init.js +41 -41
- package/dist/esm/routes/oauth2-refresh.js +29 -29
- package/dist/esm/routes/oauth2-signin.js +251 -251
- package/dist/esm/routes/webmanager.js +22 -22
- package/dist/esm/rules.js +374 -163
- package/dist/esm/sandbox.js +12 -0
- package/dist/esm/schema/user.js +19 -19
- package/dist/esm/server.js +395 -387
- package/dist/esm/settings/email.js +1 -1
- package/dist/esm/settings/index.js +168 -165
- package/dist/esm/shared/clients.js +22 -22
- package/dist/esm/shared/email.js +1 -1
- package/dist/esm/shared/env.js +1 -1
- package/dist/esm/shared/error.js +25 -25
- package/dist/esm/shared/http.js +22 -22
- package/dist/esm/shared/password.js +38 -38
- package/dist/esm/shared/rootpath.js +13 -13
- package/dist/esm/shared/signin.js +128 -128
- package/dist/esm/shared/simple-fetch.js +59 -59
- package/dist/esm/shared/tokens.js +72 -72
- package/dist/esm/shared/validate.js +41 -41
- package/dist/esm/start.js +116 -50
- package/dist/esm/test.js +8 -8
- package/dist/esm/websocket/index.js +313 -302
- package/dist/esm/websocket/manager.js +11 -11
- package/dist/esm/websocket/socket.io.js +71 -71
- package/dist/types/auth.d.ts +3 -3
- package/dist/types/cluster.d.ts +6 -1
- package/dist/types/index.d.ts +4 -4
- package/dist/types/logger.d.ts +35 -35
- package/dist/types/middleware/404.d.ts +7 -7
- package/dist/types/middleware/admin-only.d.ts +19 -19
- package/dist/types/middleware/cache.d.ts +3 -3
- package/dist/types/middleware/connection.d.ts +7 -7
- package/dist/types/middleware/context.d.ts +3 -3
- package/dist/types/middleware/cors.d.ts +25 -25
- package/dist/types/middleware/swagger.d.ts +3 -3
- package/dist/types/middleware/user.d.ts +2 -2
- package/dist/types/oauth-providers/dropbox.d.ts +52 -52
- package/dist/types/oauth-providers/facebook.d.ts +41 -41
- package/dist/types/oauth-providers/google.d.ts +43 -43
- package/dist/types/oauth-providers/index.d.ts +10 -10
- package/dist/types/oauth-providers/instagram.d.ts +50 -50
- package/dist/types/oauth-providers/oauth-provider.d.ts +74 -74
- package/dist/types/oauth-providers/spotify.d.ts +53 -53
- package/dist/types/routes/auth-change-password.d.ts +20 -20
- package/dist/types/routes/auth-delete.d.ts +16 -16
- package/dist/types/routes/auth-forgot-password.d.ts +16 -16
- package/dist/types/routes/auth-reset-password.d.ts +23 -23
- package/dist/types/routes/auth-signin.d.ts +24 -24
- package/dist/types/routes/auth-signout.d.ts +14 -14
- package/dist/types/routes/auth-signup.d.ts +32 -32
- package/dist/types/routes/auth-state.d.ts +13 -13
- package/dist/types/routes/auth-update.d.ts +33 -33
- package/dist/types/routes/auth-verify-email.d.ts +21 -21
- package/dist/types/routes/auth.d.ts +6 -6
- package/dist/types/routes/data-exists.d.ts +9 -9
- package/dist/types/routes/data-export.d.ts +10 -10
- package/dist/types/routes/data-get.d.ts +14 -14
- package/dist/types/routes/data-import.d.ts +13 -13
- package/dist/types/routes/data-index-create.d.ts +51 -51
- package/dist/types/routes/data-index-delete.d.ts +17 -17
- package/dist/types/routes/data-index-list.d.ts +21 -21
- package/dist/types/routes/data-query.d.ts +49 -49
- package/dist/types/routes/data-reflect.d.ts +29 -29
- package/dist/types/routes/data-schema-get.d.ts +11 -11
- package/dist/types/routes/data-schema-set.d.ts +20 -19
- package/dist/types/routes/data-schema-test.d.ts +19 -19
- package/dist/types/routes/data-schemas-list.d.ts +11 -11
- package/dist/types/routes/data-set.d.ts +27 -27
- package/dist/types/routes/data-sync-changes.d.ts +25 -28
- package/dist/types/routes/data-sync-mutations.d.ts +25 -28
- package/dist/types/routes/data-transaction.d.ts +34 -34
- package/dist/types/routes/data-update.d.ts +27 -27
- package/dist/types/routes/data.d.ts +3 -3
- package/dist/types/routes/docs.d.ts +3 -3
- package/dist/types/routes/meta-info.d.ts +11 -11
- package/dist/types/routes/meta-logs.d.ts +20 -20
- package/dist/types/routes/meta-ping.d.ts +7 -7
- package/dist/types/routes/meta-stats.d.ts +13 -13
- package/dist/types/routes/meta.d.ts +3 -3
- package/dist/types/routes/oauth2-init.d.ts +13 -13
- package/dist/types/routes/oauth2-refresh.d.ts +17 -17
- package/dist/types/routes/oauth2-signin.d.ts +15 -15
- package/dist/types/routes/webmanager.d.ts +3 -3
- package/dist/types/rules.d.ts +73 -34
- package/dist/types/sandbox.d.ts +3 -0
- package/dist/types/schema/user.d.ts +85 -85
- package/dist/types/server.d.ts +117 -111
- package/dist/types/settings/email.d.ts +14 -14
- package/dist/types/settings/index.d.ts +195 -187
- package/dist/types/shared/clients.d.ts +46 -46
- package/dist/types/shared/email.d.ts +34 -34
- package/dist/types/shared/env.d.ts +47 -44
- package/dist/types/shared/error.d.ts +15 -15
- package/dist/types/shared/http.d.ts +22 -21
- package/dist/types/shared/password.d.ts +19 -19
- package/dist/types/shared/rootpath.d.ts +2 -2
- package/dist/types/shared/signin.d.ts +31 -31
- package/dist/types/shared/simple-fetch.d.ts +21 -21
- package/dist/types/shared/tokens.d.ts +24 -24
- package/dist/types/shared/validate.d.ts +22 -22
- package/dist/types/start.d.ts +1 -1
- package/dist/types/test.d.ts +1 -1
- package/dist/types/websocket/index.d.ts +6 -6
- package/dist/types/websocket/manager.d.ts +99 -99
- package/dist/types/websocket/socket.io.d.ts +10 -10
- package/package.json +7 -4
- package/src/routes/data-schema-set.yaml +4 -0
- package/src/routes/data-set.yaml +5 -5
- package/src/routes/data-update.yaml +4 -4
package/dist/types/server.d.ts
CHANGED
|
@@ -1,112 +1,118 @@
|
|
|
1
|
-
import { DebugLogger, SimpleEventEmitter } from 'acebase-core';
|
|
2
|
-
import { AceBaseServerSettings, AceBaseServerConfig } from './settings';
|
|
3
|
-
import {
|
|
4
|
-
import { AceBase } from 'acebase';
|
|
5
|
-
import { OAuth2Provider } from './oauth-providers/oauth-provider';
|
|
6
|
-
import {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
*
|
|
20
|
-
* @
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
* const
|
|
42
|
-
* const
|
|
43
|
-
* await
|
|
44
|
-
*
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
*
|
|
63
|
-
* @param
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
*
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
*
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
* server.
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
*
|
|
95
|
-
* .
|
|
96
|
-
*
|
|
97
|
-
* })
|
|
98
|
-
*
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
*
|
|
105
|
-
* @param
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
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
|