@crossauth/sveltekit 1.1.1 → 1.1.3

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 (19) hide show
  1. package/dist/index.d.ts +4 -4
  2. package/dist/sveltekitadminclientendpoints.d.ts +19 -19
  3. package/dist/sveltekitadminclientendpoints.js +3 -3
  4. package/dist/sveltekitadminendpoints.d.ts +103 -75
  5. package/dist/sveltekitadminendpoints.js +11 -1
  6. package/dist/sveltekitoauthclient.d.ts +9 -9
  7. package/dist/sveltekitoauthclient.js +166 -83
  8. package/dist/sveltekitoauthserver.d.ts +27 -9
  9. package/dist/sveltekitoauthserver.js +277 -43
  10. package/dist/sveltekitserver.js +76 -62
  11. package/dist/sveltekitsession.js +95 -88
  12. package/dist/sveltekitsharedclientendpoints.d.ts +33 -26
  13. package/dist/sveltekitsharedclientendpoints.js +8 -3
  14. package/dist/sveltekituserclientendpoints.d.ts +19 -19
  15. package/dist/sveltekituserclientendpoints.js +3 -3
  16. package/dist/sveltekituserendpoints.d.ts +214 -108
  17. package/dist/sveltekituserendpoints.js +23 -0
  18. package/dist/tests/testshared.d.ts +2 -2
  19. package/package.json +3 -3
package/dist/index.d.ts CHANGED
@@ -1,20 +1,20 @@
1
1
  export { SvelteKitSessionServer, type Header } from './sveltekitsession';
2
2
  export type { SvelteKitSessionServerOptions } from './sveltekitsession';
3
- export type { LoginReturn, LogoutReturn, SignupReturn, ConfigureFactor2Return, VerifyEmailReturn, RequestPasswordResetReturn, ResetPasswordReturn, RequestFactor2Return, ChangePasswordReturn, ChangeFactor2Return, DeleteUserReturn, UpdateUserReturn, } from './sveltekituserendpoints';
4
- export type { SearchUsersReturn, AdminUpdateUserReturn, AdminCreateUserReturn, AdminDeleteUserReturn, AdminChangePasswordReturn, } from './sveltekitadminendpoints';
3
+ export type { LoginPageData, LoginActionData, LogoutPageData, LogoutActionData, SignupPageData, SignupActionData, ConfigureFactor2PageData, ConfigureFactor2ActionData, VerifyEmailPageData, RequestPasswordResetPageData, RequestPasswordActionData, ResetPasswordPageData, ResetPasswordActionData, RequestFactor2PageData, RequestFactor2ActionData, ChangePasswordPageData, ChangePasswordActionData, ChangeFactor2PageData, ChangeFactor2ActionData, DeleteUserPageData, DeleteUserActionData, UpdateUserPageData, UpdateUserActionData, } from './sveltekituserendpoints';
4
+ export type { SearchUsersPageData, SearchUsersActionData, AdminUpdateUserPageData, AdminUpdateUserActionData, AdminCreateUserPageData, AdminCreateUserActionData, AdminDeleteUserPageData, AdminDeleteUserActionData, AdminChangePasswordPageData, AdminChangePasswordActionData, } from './sveltekitadminendpoints';
5
5
  export { SvelteKitServer } from './sveltekitserver';
6
6
  export type { SvelteKitServerOptions, Resolver, SveltekitEndpoint } from './sveltekitserver';
7
7
  import type { User, ApiKey } from '@crossauth/common';
8
8
  export { JsonOrFormData } from './utils';
9
9
  export {} from './sveltekitoauthserver';
10
10
  export { SvelteKitAuthorizationServer } from './sveltekitoauthserver';
11
- export type { AuthorizeQueryType, ReturnBase, AuthorizePageData, AuthorizeFormData, DevicePageData, DeviceFormData, MfaChallengeBodyType, MfaChallengeReturn, SvelteKitAuthorizationServerOptions } from './sveltekitoauthserver';
11
+ export type { AuthorizeQueryType, ReturnBase, AuthorizePageData, AuthorizeActionData, DevicePageData, DeviceActionData, MfaChallengeBodyType, MfaChallengeReturn, SvelteKitAuthorizationServerOptions } from './sveltekitoauthserver';
12
12
  export { SvelteKitOAuthClient } from './sveltekitoauthclient';
13
13
  export type { SvelteKitErrorFn, SvelteKitOAuthClientOptions, AuthorizationCodeFlowReturn, TokenReturn, RedirectUriReturn, } from './sveltekitoauthclient';
14
14
  export { SvelteKitOAuthResourceServer } from './sveltekitresserver';
15
15
  export type { SvelteKitOAuthResourceServerOptions } from './sveltekitresserver';
16
16
  export { SvelteKitSharedClientEndpoints, defaultClientSearchFn } from './sveltekitsharedclientendpoints';
17
- export type { SearchClientsPageData, UpdateClientPageData, UpdateClientFormData, CreateClientPageData, CreateClientFormData, DeleteClientPageData, DeleteClientFormData, } from './sveltekitsharedclientendpoints';
17
+ export type { BasePageData, SearchClientsPageData, UpdateClientPageData, UpdateClientActionData, CreateClientPageData, CreateClientActionData, DeleteClientPageData, DeleteClientActionData, } from './sveltekitsharedclientendpoints';
18
18
  export { SvelteKitUserClientEndpoints } from './sveltekituserclientendpoints';
19
19
  export { SvelteKitAdminClientEndpoints } from './sveltekitadminclientendpoints';
20
20
  export { SvelteKitSessionAdapter } from './sveltekitsessionadapter';
package/dist/sveltekitadminclientendpoints.d.ts CHANGED
@@ -2,7 +2,7 @@ import { SvelteKitSessionServer } from './sveltekitsession';
2
2
  import type { SvelteKitSessionServerOptions } from './sveltekitsession';
3
3
  import type { RequestEvent } from '@sveltejs/kit';
4
4
  import { SvelteKitSharedClientEndpoints } from './sveltekitsharedclientendpoints';
5
- import type { SearchClientsPageData, UpdateClientPageData, UpdateClientFormData, DeleteClientPageData, DeleteClientFormData } from './sveltekitsharedclientendpoints';
5
+ import type { SearchClientsPageData, UpdateClientPageData, UpdateClientActionData, DeleteClientPageData, DeleteClientActionData } from './sveltekitsharedclientendpoints';
6
6
  /**
7
7
  * Endpoints for manipulating the OAuth client table, for use by admins.
8
8
  *
@@ -23,13 +23,13 @@ import type { SearchClientsPageData, UpdateClientPageData, UpdateClientFormData,
23
23
  * | searchClientsEndpoint | Returns a paginated set of clients or those matching search | See {@link SearchClientsPageData} | *Not provided* | | |
24
24
  * | -------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | --------- |
25
25
  * | updateClientEndpoint | Updates a client | See {@link UpdateClientPageData} | `default`: | | |
26
- * | | | | See {@link UpdateClientFormData} | See {@link SvelteKitSharedClientEndpoints.updateClient_internal} | client_id |
26
+ * | | | | See {@link UpdateClientActionData} | See {@link SvelteKitSharedClientEndpoints.updateClient_internal} | client_id |
27
27
  * | -------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | --------- |
28
28
  * | createClientEndpoint | Creates a new client | See {@link CreateClientPageData} | `default`: | | |
29
- * | | | | See {@link CreateClientFormData} | See {@link SvelteKitSharedClientEndpoints.createClient_internal} | client_id |
29
+ * | | | | See {@link CreateClientActionData} | See {@link SvelteKitSharedClientEndpoints.createClient_internal} | client_id |
30
30
  * | -------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | --------- |
31
31
  * | deleteClientEndpoint | Deletes a client | See {@link DeleteClientPageData} | `default`: | | |
32
- * | | | | See {@link DeleteClientFormData} | See {@link SvelteKitSharedClientEndpoints.deleteClient_internal} | client_id |
32
+ * | | | | See {@link DeleteClientActionData} | See {@link SvelteKitSharedClientEndpoints.deleteClient_internal} | client_id |
33
33
  * | -------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | --------- |
34
34
  */
35
35
  export declare class SvelteKitAdminClientEndpoints extends SvelteKitSharedClientEndpoints {
@@ -50,7 +50,7 @@ export declare class SvelteKitAdminClientEndpoints extends SvelteKitSharedClient
50
50
  /**
51
51
  * See {@link SvelteKitSharedClientEndpoints.updateClient_internal}
52
52
  */
53
- updateClient(event: RequestEvent): Promise<UpdateClientFormData>;
53
+ updateClient(event: RequestEvent): Promise<UpdateClientActionData>;
54
54
  /**
55
55
  * See {@link SvelteKitSharedClientEndpoints.emptyClient_internal}
56
56
  */
@@ -58,7 +58,7 @@ export declare class SvelteKitAdminClientEndpoints extends SvelteKitSharedClient
58
58
  /**
59
59
  * See {@link SvelteKitSharedClientEndpoints.createClient_internal}
60
60
  */
61
- createClient(event: RequestEvent): Promise<UpdateClientFormData>;
61
+ createClient(event: RequestEvent): Promise<UpdateClientActionData>;
62
62
  /**
63
63
  * See {@link SvelteKitSharedClientEndpoints.loadDeleteClient_internal}
64
64
  */
@@ -66,7 +66,7 @@ export declare class SvelteKitAdminClientEndpoints extends SvelteKitSharedClient
66
66
  /**
67
67
  * See {@link SvelteKitSharedClientEndpoints.deleteClient_internal}
68
68
  */
69
- deleteClient(event: RequestEvent): Promise<DeleteClientFormData>;
69
+ deleteClient(event: RequestEvent): Promise<DeleteClientActionData>;
70
70
  /**
71
71
  * See class documentation.
72
72
  */
@@ -92,22 +92,22 @@ export declare class SvelteKitAdminClientEndpoints extends SvelteKitSharedClient
92
92
  */
93
93
  readonly updateClientEndpoint: {
94
94
  load: (event: RequestEvent) => Promise<{
95
- ok: boolean;
95
+ ok?: boolean | undefined;
96
96
  client?: import("@crossauth/common").OAuthClient | undefined;
97
97
  client_id?: string | undefined;
98
98
  clientUsername?: string | undefined;
99
99
  error?: string | undefined;
100
100
  errorCode?: number | undefined;
101
101
  errorCodeName?: string | undefined;
102
- validFlows: string[];
103
- valid_flowNames: {
102
+ validFlows?: string[] | undefined;
103
+ valid_flowNames?: {
104
104
  [key: string]: string;
105
- };
105
+ } | undefined;
106
106
  user: import("@crossauth/common").User | undefined;
107
107
  csrfToken: string | undefined;
108
108
  }>;
109
109
  actions: {
110
- default: (event: RequestEvent) => Promise<UpdateClientFormData>;
110
+ default: (event: RequestEvent) => Promise<UpdateClientActionData>;
111
111
  };
112
112
  };
113
113
  /**
@@ -115,22 +115,22 @@ export declare class SvelteKitAdminClientEndpoints extends SvelteKitSharedClient
115
115
  */
116
116
  readonly createClientEndpoint: {
117
117
  load: (event: RequestEvent) => Promise<{
118
- ok: boolean;
118
+ ok?: boolean | undefined;
119
119
  client?: import("@crossauth/common").OAuthClient | undefined;
120
120
  client_id?: string | undefined;
121
121
  clientUsername?: string | undefined;
122
122
  error?: string | undefined;
123
123
  errorCode?: number | undefined;
124
124
  errorCodeName?: string | undefined;
125
- validFlows: string[];
126
- valid_flowNames: {
125
+ validFlows?: string[] | undefined;
126
+ valid_flowNames?: {
127
127
  [key: string]: string;
128
- };
128
+ } | undefined;
129
129
  user: import("@crossauth/common").User | undefined;
130
130
  csrfToken: string | undefined;
131
131
  }>;
132
132
  actions: {
133
- default: (event: RequestEvent) => Promise<UpdateClientFormData>;
133
+ default: (event: RequestEvent) => Promise<UpdateClientActionData>;
134
134
  };
135
135
  };
136
136
  /**
@@ -138,7 +138,7 @@ export declare class SvelteKitAdminClientEndpoints extends SvelteKitSharedClient
138
138
  */
139
139
  readonly deleteClientEndpoint: {
140
140
  load: (event: RequestEvent) => Promise<{
141
- ok: boolean;
141
+ ok?: boolean | undefined;
142
142
  client?: import("@crossauth/common").OAuthClient | undefined;
143
143
  client_id?: string | undefined;
144
144
  clientUsername?: string | undefined;
@@ -149,7 +149,7 @@ export declare class SvelteKitAdminClientEndpoints extends SvelteKitSharedClient
149
149
  csrfToken: string | undefined;
150
150
  }>;
151
151
  actions: {
152
- default: (event: RequestEvent) => Promise<DeleteClientFormData>;
152
+ default: (event: RequestEvent) => Promise<DeleteClientActionData>;
153
153
  };
154
154
  };
155
155
  }
package/dist/sveltekitadminclientendpoints.js CHANGED
@@ -26,13 +26,13 @@ import { SvelteKitSharedClientEndpoints } from './sveltekitsharedclientendpoints
26
26
  * | searchClientsEndpoint | Returns a paginated set of clients or those matching search | See {@link SearchClientsPageData} | *Not provided* | | |
27
27
  * | -------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | --------- |
28
28
  * | updateClientEndpoint | Updates a client | See {@link UpdateClientPageData} | `default`: | | |
29
- * | | | | See {@link UpdateClientFormData} | See {@link SvelteKitSharedClientEndpoints.updateClient_internal} | client_id |
29
+ * | | | | See {@link UpdateClientActionData} | See {@link SvelteKitSharedClientEndpoints.updateClient_internal} | client_id |
30
30
  * | -------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | --------- |
31
31
  * | createClientEndpoint | Creates a new client | See {@link CreateClientPageData} | `default`: | | |
32
- * | | | | See {@link CreateClientFormData} | See {@link SvelteKitSharedClientEndpoints.createClient_internal} | client_id |
32
+ * | | | | See {@link CreateClientActionData} | See {@link SvelteKitSharedClientEndpoints.createClient_internal} | client_id |
33
33
  * | -------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | --------- |
34
34
  * | deleteClientEndpoint | Deletes a client | See {@link DeleteClientPageData} | `default`: | | |
35
- * | | | | See {@link DeleteClientFormData} | See {@link SvelteKitSharedClientEndpoints.deleteClient_internal} | client_id |
35
+ * | | | | See {@link DeleteClientActionData} | See {@link SvelteKitSharedClientEndpoints.deleteClient_internal} | client_id |
36
36
  * | -------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | --------- |
37
37
  */
38
38
  export class SvelteKitAdminClientEndpoints extends SvelteKitSharedClientEndpoints {
package/dist/sveltekitadminendpoints.d.ts CHANGED
@@ -1,15 +1,33 @@
1
1
  import { SvelteKitSessionServer } from './sveltekitsession';
2
2
  import type { SvelteKitSessionServerOptions } from './sveltekitsession';
3
3
  import type { User, UserInputFields } from '@crossauth/common';
4
- import { ErrorCode } from '@crossauth/common';
5
4
  import type { RequestEvent } from '@sveltejs/kit';
5
+ /**
6
+ * Return type for {@link SvelteKitAdminEndpoints.updateUser}
7
+ * {@link SvelteKitAdminEndpoints.updateUserEndpoint} load.
8
+ *
9
+ * See class documentation for {@link SvelteKitUserEndpoints} for more details.
10
+ */
11
+ export interface AdminUpdateUserPageData {
12
+ user?: User;
13
+ csrfToken?: string;
14
+ error?: string;
15
+ errorCode?: number;
16
+ errorCodeName?: string;
17
+ allowedFactor2: {
18
+ name: string;
19
+ friendlyName: string;
20
+ configurable: boolean;
21
+ }[];
22
+ editUser?: User;
23
+ }
6
24
  /**
7
25
  * Return type for {@link SvelteKitAdminEndpoints.updateUser}
8
26
  * {@link SvelteKitAdminEndpoints.updateUserEndpoint} action.
9
27
  *
10
28
  * See class documentation for {@link SvelteKitUserEndpoints} for more details.
11
29
  */
12
- export type AdminUpdateUserReturn = {
30
+ export interface AdminUpdateUserActionData {
13
31
  user?: User;
14
32
  error?: string;
15
33
  errorCode?: number;
@@ -19,14 +37,27 @@ export type AdminUpdateUserReturn = {
19
37
  };
20
38
  ok: boolean;
21
39
  info?: string;
22
- };
40
+ }
41
+ /**
42
+ * Return type for {@link SvelteKitAdminEndpoints.changePassword}
43
+ * {@link SvelteKitAdminEndpoints.changePasswordEndpoint} load.
44
+ *
45
+ * See class documentation for {@link SvelteKitUserEndpoints} for more details.
46
+ */
47
+ export interface AdminChangePasswordPageData {
48
+ user?: User;
49
+ csrfToken?: string;
50
+ error?: string;
51
+ errorCode?: number;
52
+ errorCodeName?: string;
53
+ }
23
54
  /**
24
55
  * Return type for {@link SvelteKitAdminEndpoints.changePassword}
25
56
  * {@link SvelteKitAdminEndpoints.changePasswordEndpoint} action.
26
57
  *
27
58
  * See class documentation for {@link SvelteKitUserEndpoints} for more details.
28
59
  */
29
- export type AdminChangePasswordReturn = {
60
+ export interface AdminChangePasswordActionData {
30
61
  user?: User;
31
62
  error?: string;
32
63
  errorCode?: number;
@@ -35,14 +66,32 @@ export type AdminChangePasswordReturn = {
35
66
  [key: string]: string;
36
67
  };
37
68
  ok: boolean;
38
- };
69
+ }
70
+ /**
71
+ * Return type for {@link SvelteKitAdminEndpoints.createUser}
72
+ * {@link SvelteKitAdminEndpoints.createUserEndpoint} load.
73
+ *
74
+ * See class documentation for {@link SvelteKitUserEndpoints} for more details.
75
+ */
76
+ export interface AdminCreateUserPageData {
77
+ user?: User;
78
+ csrfToken?: string;
79
+ error?: string;
80
+ errorCode?: number;
81
+ errorCodeName?: string;
82
+ allowedFactor2: {
83
+ name: string;
84
+ friendlyName: string;
85
+ configurable: boolean;
86
+ }[];
87
+ }
39
88
  /**
40
89
  * Return type for {@link SvelteKitAdminEndpoints.createUser}
41
90
  * {@link SvelteKitAdminEndpoints.createUserEndpoint} action.
42
91
  *
43
92
  * See class documentation for {@link SvelteKitUserEndpoints} for more details.
44
93
  */
45
- export type AdminCreateUserReturn = {
94
+ export interface AdminCreateUserActionData {
46
95
  user?: UserInputFields;
47
96
  factor2Data?: {
48
97
  userData: {
@@ -59,27 +108,55 @@ export type AdminCreateUserReturn = {
59
108
  [key: string]: string | undefined;
60
109
  };
61
110
  ok: boolean;
62
- };
111
+ }
112
+ /**
113
+ * Return type for {@link SvelteKitAdminEndpoints.deleteUser}
114
+ * {@link SvelteKitAdminEndpoints.deleteUserEndpoint} load.
115
+ *
116
+ * See class documentation for {@link SvelteKitUserEndpoints} for more details.
117
+ */
118
+ export interface AdminDeleteUserPageData {
119
+ user?: User;
120
+ csrfToken?: string;
121
+ error?: string;
122
+ errorCode?: number;
123
+ errorCodeName?: string;
124
+ username?: string;
125
+ }
63
126
  /**
64
127
  * Return type for {@link SvelteKitAdminEndpoints.deleteUser}
65
128
  * {@link SvelteKitAdminEndpoints.deleteUserEndpoint} action.
66
129
  *
67
130
  * See class documentation for {@link SvelteKitUserEndpoints} for more details.
68
131
  */
69
- export type AdminDeleteUserReturn = {
132
+ export interface AdminDeleteUserActionData {
70
133
  user?: User;
71
134
  error?: string;
72
135
  errorCode?: number;
73
136
  errorCodeName?: string;
74
137
  ok: boolean;
75
- };
138
+ }
139
+ /**
140
+ * Return type for {@link SvelteKitAdminEndpoints.searchUsers}
141
+ * {@link SvelteKitAdminEndpoints.searchUsersEndpoint} load.
142
+ *
143
+ * See class documentation for {@link SvelteKitUserEndpoints} for more details.
144
+ */
145
+ export interface SearchUsersPageData {
146
+ user?: User;
147
+ editUser?: User;
148
+ csrfToken?: string;
149
+ error?: string;
150
+ errorCode?: number;
151
+ errorCodeName?: string;
152
+ }
76
153
  /**
77
154
  * Return type for {@link SvelteKitAdminEndpoints.searchUsers}
78
155
  * {@link SvelteKitAdminEndpoints.searchUsersEndpoint} action.
79
156
  *
80
157
  * See class documentation for {@link SvelteKitUserEndpoints} for more details.
81
158
  */
82
- export type SearchUsersReturn = {
159
+ export interface SearchUsersActionData {
83
160
  ok: boolean;
84
161
  users?: User[];
85
162
  skip: number;
@@ -90,7 +167,7 @@ export type SearchUsersReturn = {
90
167
  errorCodeName?: string;
91
168
  hasPrevious: boolean;
92
169
  hasNext: boolean;
93
- };
170
+ }
94
171
  /**
95
172
  * Provides endpoints for users to login, logout and maintain their
96
173
  * own account.
@@ -124,7 +201,7 @@ export type SearchUsersReturn = {
124
201
  * | baseEndpoint | This PageData is returned by all endpoints' load function. | - `user` logged in {@link @crossauth/common!User} | *Not provided* | | |
125
202
  * | | | - `csrfToken` CSRF token if enabled | | | | | loginPage |
126
203
  * | -------------------------- | ---------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ----------------------------------------------------------- | --------- |
127
- * | searchUsersEndpoint | Returns a paginated set of users or those matchign search | See return of {@link SvelteKitAdminEndpoints.searchUsers} | *Not provided* | | |
204
+ * | searchUsersEndpoint | Returns a paginated set of users or those matchign search | See return of searchUsers | *Not provided* | | |
128
205
  * | -------------------------- | ---------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ----------------------------------------------------------- | --------- |
129
206
  * | updateUserEndpoint | Update a user's details | - `allowedFactor2` see {@link SvelteKitAdminEndpoints}.`signupEndpoint` | `default`: | `default`: | `id` |
130
207
  * | | | - `editUser` the {@link @crossauth/common!User} being edited | - see {@link SvelteKitAdminEndpoints.updateUser} return | - see {@link SvelteKitAdminEndpoints.updateUser} event | |
@@ -181,7 +258,7 @@ export declare class SvelteKitAdminEndpoints {
181
258
  * - `hasPrevious` whether there are more results before the ones that
182
259
  * were returned.
183
260
  */
184
- searchUsers(event: RequestEvent, searchTerm?: string, skip?: number, take?: number): Promise<SearchUsersReturn>;
261
+ searchUsers(event: RequestEvent, searchTerm?: string, skip?: number, take?: number): Promise<SearchUsersActionData>;
185
262
  /**
186
263
  * Call this to update a user's details.
187
264
  *
@@ -213,7 +290,7 @@ export declare class SvelteKitAdminEndpoints {
213
290
  * - `exception` a {@link @crossauth/common!CrossauthError} if an
214
291
  * exception was raised
215
292
  */
216
- updateUser(user: User, event: RequestEvent): Promise<AdminUpdateUserReturn>;
293
+ updateUser(user: User, event: RequestEvent): Promise<AdminUpdateUserActionData>;
217
294
  /**
218
295
  * Call this with POST data to change the logged-in user's password
219
296
  *
@@ -233,7 +310,7 @@ export declare class SvelteKitAdminEndpoints {
233
310
  * exception was raised
234
311
  * - `formData` the form fields extracted from the request
235
312
  */
236
- changePassword(user: User, event: RequestEvent): Promise<AdminChangePasswordReturn>;
313
+ changePassword(user: User, event: RequestEvent): Promise<AdminChangePasswordActionData>;
237
314
  /**
238
315
  * Creates an account.
239
316
  *
@@ -279,7 +356,7 @@ export declare class SvelteKitAdminEndpoints {
279
356
  * - `emailVerificationRequired` if true, the user needs to click on
280
357
  * the link emailed to them to complete signup.
281
358
  */
282
- createUser(event: RequestEvent): Promise<AdminCreateUserReturn>;
359
+ createUser(event: RequestEvent): Promise<AdminCreateUserActionData>;
283
360
  /**
284
361
  * Call this to delete the logged-in user
285
362
  *
@@ -293,86 +370,37 @@ export declare class SvelteKitAdminEndpoints {
293
370
  * - `exception` a {@link @crossauth/common!CrossauthError} if an
294
371
  * exception was raised
295
372
  */
296
- deleteUser(event: RequestEvent): Promise<AdminDeleteUserReturn>;
373
+ deleteUser(event: RequestEvent): Promise<AdminDeleteUserActionData>;
297
374
  baseEndpoint(event: RequestEvent): {
298
375
  user: User | undefined;
299
376
  csrfToken: string | undefined;
300
377
  };
301
378
  readonly searchUsersEndpoint: {
302
- load: (event: RequestEvent) => Promise<{
303
- ok: boolean;
304
- users?: User[] | undefined;
305
- skip: number;
306
- take: number;
307
- search?: string | undefined;
308
- error?: string | undefined;
309
- errorCode?: number | undefined;
310
- errorCodeName?: string | undefined;
311
- hasPrevious: boolean;
312
- hasNext: boolean;
313
- user: User | undefined;
314
- csrfToken: string | undefined;
315
- }>;
379
+ load: (event: RequestEvent) => Promise<SearchUsersPageData>;
316
380
  };
317
381
  private getUserFromParam;
318
382
  readonly updateUserEndpoint: {
319
383
  actions: {
320
- default: (event: RequestEvent) => Promise<AdminUpdateUserReturn>;
384
+ default: (event: RequestEvent) => Promise<AdminUpdateUserActionData>;
321
385
  };
322
- load: (event: RequestEvent) => Promise<{
323
- user: User | undefined;
324
- csrfToken: string | undefined;
325
- allowedFactor2: {
326
- name: string;
327
- friendlyName: string;
328
- configurable: boolean;
329
- }[];
330
- editUser: User | undefined;
331
- }>;
386
+ load: (event: RequestEvent) => Promise<AdminUpdateUserPageData>;
332
387
  };
333
388
  readonly changePasswordEndpoint: {
334
389
  actions: {
335
- default: (event: RequestEvent) => Promise<AdminChangePasswordReturn>;
390
+ default: (event: RequestEvent) => Promise<AdminChangePasswordActionData>;
336
391
  };
337
- load: (event: RequestEvent) => Promise<{
338
- user: User | undefined;
339
- csrfToken: string | undefined;
340
- editUser: User | undefined;
341
- } | {
342
- user: User | undefined;
343
- csrfToken: string | undefined;
344
- editUser: User;
345
- next?: string | undefined;
346
- }>;
392
+ load: (event: RequestEvent) => Promise<SearchUsersPageData>;
347
393
  };
348
394
  readonly createUserEndpoint: {
349
- load: (event: RequestEvent) => Promise<{
350
- user: User | undefined;
351
- csrfToken: string | undefined;
352
- allowedFactor2: {
353
- name: string;
354
- friendlyName: string;
355
- configurable: boolean;
356
- }[];
357
- }>;
395
+ load: (event: RequestEvent) => Promise<AdminCreateUserPageData>;
358
396
  actions: {
359
- default: (event: RequestEvent) => Promise<AdminCreateUserReturn>;
397
+ default: (event: RequestEvent) => Promise<AdminCreateUserActionData>;
360
398
  };
361
399
  };
362
400
  readonly deleteUserEndpoint: {
363
401
  actions: {
364
- default: (event: RequestEvent) => Promise<AdminDeleteUserReturn>;
402
+ default: (event: RequestEvent) => Promise<AdminDeleteUserActionData>;
365
403
  };
366
- load: (event: RequestEvent) => Promise<{
367
- user: User | undefined;
368
- csrfToken: string | undefined;
369
- error: string;
370
- errorCode: ErrorCode | undefined;
371
- errorCodeName: string | undefined;
372
- } | {
373
- user: User | undefined;
374
- csrfToken: string | undefined;
375
- username: string;
376
- }>;
404
+ load: (event: RequestEvent) => Promise<AdminDeleteUserPageData>;
377
405
  };
378
406
  }
package/dist/sveltekitadminendpoints.js CHANGED
@@ -4,6 +4,16 @@ import { SvelteKitSessionServer } from './sveltekitsession';
4
4
  import { TokenEmailer } from '@crossauth/backend';
5
5
  import { CrossauthError, CrossauthLogger, j, ErrorCode, UserState } from '@crossauth/common';
6
6
  import { JsonOrFormData } from './utils';
7
+ ;
8
+ ;
9
+ ;
10
+ ;
11
+ ;
12
+ ;
13
+ ;
14
+ ;
15
+ ;
16
+ ;
7
17
  /**
8
18
  * Default function for searching users.
9
19
  *
@@ -76,7 +86,7 @@ async function defaultUserSearchFn(searchTerm, userStorage, skip = 0, _take = 10
76
86
  * | baseEndpoint | This PageData is returned by all endpoints' load function. | - `user` logged in {@link @crossauth/common!User} | *Not provided* | | |
77
87
  * | | | - `csrfToken` CSRF token if enabled | | | | | loginPage |
78
88
  * | -------------------------- | ---------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ----------------------------------------------------------- | --------- |
79
- * | searchUsersEndpoint | Returns a paginated set of users or those matchign search | See return of {@link SvelteKitAdminEndpoints.searchUsers} | *Not provided* | | |
89
+ * | searchUsersEndpoint | Returns a paginated set of users or those matchign search | See return of searchUsers | *Not provided* | | |
80
90
  * | -------------------------- | ---------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ----------------------------------------------------------- | --------- |
81
91
  * | updateUserEndpoint | Update a user's details | - `allowedFactor2` see {@link SvelteKitAdminEndpoints}.`signupEndpoint` | `default`: | `default`: | `id` |
82
92
  * | | | - `editUser` the {@link @crossauth/common!User} being edited | - see {@link SvelteKitAdminEndpoints.updateUser} return | - see {@link SvelteKitAdminEndpoints.updateUser} event | |
package/dist/sveltekitoauthclient.d.ts CHANGED
@@ -62,7 +62,7 @@ export interface SvelteKitOAuthClientOptions extends OAuthClientOptions {
62
62
  */
63
63
  receiveTokenFn?: (oauthResponse: OAuthTokenResponse, client: SvelteKitOAuthClient, event: RequestEvent, silent: boolean, setUserFn: (event: RequestEvent, token: {
64
64
  [key: string]: any;
65
- }) => Promise<void>) => Promise<Response | TokenReturn | undefined>;
65
+ }) => Promise<void>) => Promise<Response | TokenReturn>;
66
66
  /**
67
67
  * The function to call when there is an OAuth error and
68
68
  * {@link SvelteKitOAuthClientOptions.errorResponseType}
@@ -440,19 +440,19 @@ export declare class SvelteKitOAuthClient extends OAuthClientBackend {
440
440
  load: (event: RequestEvent) => Promise<AuthorizationCodeFlowReturn>;
441
441
  };
442
442
  readonly redirectUriEndpoint: {
443
- get: (event: RequestEvent) => Promise<Response | TokenReturn | undefined>;
443
+ get: (event: RequestEvent) => Promise<Response>;
444
444
  load: (event: RequestEvent) => Promise<RedirectUriReturn>;
445
445
  };
446
446
  readonly clientCredentialsFlowEndpoint: {
447
447
  post: (event: RequestEvent) => Promise<Response>;
448
448
  actions: {
449
- default: (event: RequestEvent) => Promise<{}>;
449
+ default: (event: RequestEvent) => Promise<Response | TokenReturn>;
450
450
  };
451
451
  };
452
452
  readonly refreshTokenFlowEndpoint: {
453
453
  post: (event: RequestEvent) => Promise<Response>;
454
454
  actions: {
455
- default: (event: RequestEvent) => Promise<{}>;
455
+ default: (event: RequestEvent) => Promise<Response | TokenReturn>;
456
456
  };
457
457
  };
458
458
  readonly refreshTokensIfExpiredEndpoint: {
@@ -505,9 +505,9 @@ export declare class SvelteKitOAuthClient extends OAuthClientBackend {
505
505
  ok: boolean;
506
506
  }>;
507
507
  actions: {
508
- password: (event: RequestEvent) => Promise<{}>;
509
- passwordOtp: (event: RequestEvent) => Promise<{}>;
510
- passwordOob: (event: RequestEvent) => Promise<{}>;
508
+ password: (event: RequestEvent) => Promise<Response | OAuthTokenResponse>;
509
+ passwordOtp: (event: RequestEvent) => Promise<Response | OAuthTokenResponse>;
510
+ passwordOob: (event: RequestEvent) => Promise<Response | OAuthTokenResponse>;
511
511
  };
512
512
  };
513
513
  readonly passwordOtpEndpoint: {
@@ -532,7 +532,7 @@ export declare class SvelteKitOAuthClient extends OAuthClientBackend {
532
532
  ok: boolean;
533
533
  }>;
534
534
  actions: {
535
- default: (event: RequestEvent) => Promise<{}>;
535
+ default: (event: RequestEvent) => Promise<Response | OAuthTokenResponse>;
536
536
  };
537
537
  };
538
538
  readonly passwordOobEndpoint: {
@@ -557,7 +557,7 @@ export declare class SvelteKitOAuthClient extends OAuthClientBackend {
557
557
  ok: boolean;
558
558
  }>;
559
559
  actions: {
560
- default: (event: RequestEvent) => Promise<{}>;
560
+ default: (event: RequestEvent) => Promise<Response | OAuthTokenResponse>;
561
561
  };
562
562
  };
563
563
  readonly deleteTokensEndpoint: {