@crossauth/sveltekit 0.0.2

package/dist/sveltekituserendpoints.d.ts

@@ -0,0 +1,730 @@
+import { SveltekitEndpoint } from './sveltekitserver';
+import { SvelteKitSessionServer, SvelteKitSessionServerOptions } from './sveltekitsession';
+import { User, UserInputFields, CrossauthError } from '@crossauth/common';
+import { RequestEvent } from '@sveltejs/kit';
+
+/**
+ * Return type for {@link SvelteKitUserEndpoints.login},
+ * {@link SvelteKitUserEndpoints.loginFactor2} and the
+ * {@link SvelteKitUserEndpoints.loginEndpoint} action.
+ *
+ * See class documentation for {@link SvelteKitUserEndpoints} for more details.
+ */
+export type LoginReturn = {
+    user?: User;
+    error?: string;
+    exception?: CrossauthError;
+    formData?: {
+        [key: string]: string;
+    };
+    factor2Required?: boolean;
+    ok: boolean;
+};
+/**
+ * Return type for {@link SvelteKitUserEndpoints.logout}
+ * {@link SvelteKitUserEndpoints.logoutEndpoint} action.
+ *
+ * See class documentation for {@link SvelteKitUserEndpoints} for more details.
+ */
+export type LogoutReturn = {
+    ok: boolean;
+    error?: string;
+    exception?: CrossauthError;
+};
+/**
+ * Return type for {@link SvelteKitUserEndpoints.signuput}
+ * {@link SvelteKitUserEndpoints.signupEndpoint} action.
+ *
+ * See class documentation for {@link SvelteKitUserEndpoints} for more details.
+ */
+export type SignupReturn = {
+    user?: UserInputFields;
+    factor2Data?: {
+        userData: {
+            [key: string]: any;
+        };
+        username: string;
+        csrfToken?: string | undefined;
+        factor2: string;
+    };
+    error?: string;
+    exception?: CrossauthError;
+    formData?: {
+        [key: string]: string | undefined;
+    };
+    ok: boolean;
+    factor2Required?: boolean;
+    emailVerificationRequired?: boolean;
+};
+/**
+ * Return type for {@link SvelteKitUserEndpoints.configureFactor2}
+ * {@link SvelteKitUserEndpoints.configureFactor2Endpoint} action.
+ *
+ * See class documentation for {@link SvelteKitUserEndpoints} for more details.
+ */
+export type ConfigureFactor2Return = {
+    user?: UserInputFields;
+    factor2Data?: {
+        userData: {
+            [key: string]: any;
+        };
+        username: string;
+        csrfToken?: string | undefined;
+        factor2: string;
+    };
+    error?: string;
+    exception?: CrossauthError;
+    formData?: {
+        [key: string]: string | undefined;
+    };
+    ok: boolean;
+    emailVerificationRequired?: boolean;
+};
+/**
+ * Return type for {@link SvelteKitUserEndpoints.verifyEmail}
+ * {@link SvelteKitUserEndpoints.verifyEmailEndpoint} action.
+ *
+ * See class documentation for {@link SvelteKitUserEndpoints} for more details.
+ */
+export type VerifyEmailReturn = {
+    user?: User;
+    error?: string;
+    exception?: CrossauthError;
+    ok: boolean;
+};
+/**
+ * Return type for {@link SvelteKitUserEndpoints.requestPasswordReset}
+ * {@link SvelteKitUserEndpoints.resetPasswordEndpoint} action.
+ *
+ * See class documentation for {@link SvelteKitUserEndpoints} for more details.
+ */
+export type RequestPasswordResetReturn = {
+    user?: User;
+    formData?: {
+        [key: string]: string | undefined;
+    };
+    error?: string;
+    exception?: CrossauthError;
+    ok: boolean;
+};
+/**
+ * Return type for {@link SvelteKitUserEndpoints.resetPassword}
+ * {@link SvelteKitUserEndpoints.validatePasswordResetToken} and the
+ * {@link SvelteKitUserEndpoints.passwordResetTokenEndpoint} action.
+ *
+ * See class documentation for {@link SvelteKitUserEndpoints} for more details.
+ */
+export type ResetPasswordReturn = {
+    user?: User;
+    formData?: {
+        [key: string]: string | undefined;
+    };
+    error?: string;
+    exception?: CrossauthError;
+    ok: boolean;
+};
+/**
+ * Return type for {@link SvelteKitUserEndpoints.requestFactor2}
+ * {@link SvelteKitUserEndpoints.factor2Endpoint} action.
+ *
+ * See class documentation for {@link SvelteKitUserEndpoints} for more details.
+ */
+export type RequestFactor2Return = {
+    ok: boolean;
+    action?: string;
+    factor2?: string;
+    error?: string;
+    exception?: CrossauthError;
+    csrfToken?: string;
+};
+/**
+ * Return type for {@link SvelteKitUserEndpoints.changePassword}
+ * {@link SvelteKitUserEndpoints.changePasswordEndpoint} action.
+ *
+ * See class documentation for {@link SvelteKitUserEndpoints} for more details.
+ */
+export type ChangePasswordReturn = {
+    user?: User;
+    error?: string;
+    exception?: CrossauthError;
+    formData?: {
+        [key: string]: string;
+    };
+    ok: boolean;
+};
+/**
+ * Return type for {@link SvelteKitUserEndpoints.changeFactor2}
+ * {@link SvelteKitUserEndpoints.changeFactor2Endpoint} action.
+ *
+ * See class documentation for {@link SvelteKitUserEndpoints} for more details.
+ */
+export type ChangeFactor2Return = {
+    user?: User;
+    error?: string;
+    exception?: CrossauthError;
+    formData?: {
+        [key: string]: string;
+    };
+    ok: boolean;
+    factor2Data?: {
+        userData: {
+            [key: string]: any;
+        };
+        username: string;
+        csrfToken?: string | undefined;
+        factor2: string;
+    };
+};
+/**
+ * Return type for {@link SvelteKitUserEndpoints.deleteUser}
+ * {@link SvelteKitUserEndpoints.deleteUserEndpoint} action.
+ *
+ * See class documentation for {@link SvelteKitUserEndpoints} for more details.
+ */
+export type DeleteUserReturn = {
+    user?: User;
+    error?: string;
+    exception?: CrossauthError;
+    ok: boolean;
+};
+/**
+ * Return type for {@link SvelteKitUserEndpoints.updateUser}
+ * {@link SvelteKitUserEndpoints.updateUserEndpoint} action.
+ *
+ * See class documentation for {@link SvelteKitUserEndpoints} for more details.
+ */
+export type UpdateUserReturn = {
+    user?: User;
+    error?: string;
+    exception?: CrossauthError;
+    formData?: {
+        [key: string]: string;
+    };
+    emailVerificationNeeded: boolean;
+    ok: boolean;
+};
+/**
+ * Provides endpoints for users to login, logout and maintain their
+ * own account.
+ *
+ * This is created automatically when {@link SveltekitServer} is instantiated.
+ * The endpoints are available through `SveltekitServer.sessionServer.userEndpoints`.
+ *
+ * The methods in this class are designed to be used in
+ * `+*_server.ts` files in the `load` and `actions` exports.  You can
+ * either use the low-level functions such as {@link changePassword} or use
+ * the `action` and `load` members of the endpoint objects.
+ * For example, for {@link changePasswordEndpoint}
+ *
+ * ```
+ * export const load = crossauth.sessionServer?.userEndpoints.changeFactor2Endpoint.load ?? crossauth.dummyLoad;
+ * export const actions = crossauth.sessionServer?.userEndpoints.changeFactor2Endpoint.actions ?? crossauth.dummyActions;
+ * ```
+ * The `?? crossauth.dummyLoad` and `?? crossauth.dummyActions` is to stop
+ * typescript complaining as the `sessionServer` member of the
+ * {@link @crossauth/sveltekit/SveltekitServer} object may be undefined, because
+ * some application do not have a session server.
+ *
+ * **Endpoints**
+ *
+ * | Name                       | Description                                                | PageData (returned by load)                                                  | ActionData (return by actions)                                   | Form fields expected by actions                                 | URL param |
+ * | -------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------- | --------------------------------------------------------------- | --------- |
+ * | baseEndpoint               | This PageData is returned by all endpoints' load function. | - `user` logged in {@link @crossauth/common!User}                            | *Not provided*                                                   |                                                                 |           |
+ * |                            |                                                            | - `csrfToken` CSRF token if enabled                                          |                                                                  |                                                                 |           |                                                                                  | loginPage                |
+ * | -------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------- | --------------------------------------------------------------- | --------- |
+ * | signupEndpoint             | Create a user and sign in                                  | - `allowedFactor2` array of:                                                 | `default`:                                                       | `default`:                                                      |           |
+ * |                            |                                                            |    -  `name` name that is in user's `factor2`                                |  - see {@link SveltekitEndpoint.signup} return                   |  - see {@link SveltekitUserEndpoint.signup} event               |           |
+ * |                            |                                                            |    -  `friendlyName` for showing in form                                     |                                                                  |                                                                 |           |
+ * | -------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------- | --------------------------------------------------------------- | --------- |
+ * | loginEndpoint              | Logs a user in                                             | - `next` page to redirect to on ok                                      | `login`: starts login                                            | `login`:                                                        |           |
+ * |                            |                                                            |                                                                              |  - see {@link SveltekitEndpoint.login} return                    |  - see {@link SveltekitUserEndpoint.login} event                |           |
+ * |                            |                                                            |                                                                              | `factor2`: submit 2FA data to complete login                     | `factor2`:                                                      |           |
+ * |                            |                                                            |                                                                              |  - see {@link SveltekitEndpoint.loginFactor2} return             |  - see {@link SveltekitUserEndpoint.loginFactor2} event         |           |
+ * | -------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------- | --------------------------------------------------------------- | --------- |
+ * | factor2Endpoint            | Called when 2FA authentication is needed                   | See {@link SvelteKitUserEndpoints.requestFactor2} return                     |  *Not provided*                                                  |                                                                 |           |
+ * | -------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------- | --------------------------------------------------------------- | --------- |
+ * | logoutEndpoint             | Logs a user out                                            | Just `baseEndpoint` data                                                     | `default`:                                                       | `default`:                                                      |           |
+ * |                            |                                                            |                                                                              |  - see {@link SveltekitUserEndpoint.logout} return               |  - see {@link SveltekitUserEndpoint.logout} event               |           |
+ * | -------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------- | --------------------------------------------------------------- | --------- |
+ * | changeFactor2Endpoint      | Change user's factor2 method or reconfigure existing       | - `next` page to redirect to on ok                                      | `change`: change to a different factor2                          | `change`:                                                       |           |
+ * |                            |                                                            | - `required` if true, this was called because the user must                  |  - see {@link SveltekitUserEndpoint.changeFactor2} return        |  - see {@link SveltekitUserEndpoint.changeFactor2} event        |           |
+ * |                            |                                                            |    eg if user's `state` set to `factor2ResetRequired`                        | `factor2`: submit 2FA data to complete login                     | `factor2`:                                                      |           |
+ * |                            |                                                            | - `username` the user's username (`user` not set if not fully logged in yet) |  - see {@link SveltekitUserEndpoint.loginFactor2} return         |  - see {@link SveltekitUserEndpoint.loginFactor2} event         |           |
+ * |                            |                                                            | - `allowedFactor2` see PageData for `signupEndpoint`                         |                                                                  |                                                                 |           |
+ * | -------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------- | --------------------------------------------------------------- | --------- |
+ * | changePasswordEndpoint     | Change user's factor2 method or reconfigure existing       | - `next` page to redirect to on ok                                      | `default`:                                                       | `default`:                                                      |           |
+ * |                            |                                                            | - `required` if true, this was called because the user must                  |  - see {@link SveltekitUserEndpoint.changePassword} return       |  - see {@link SveltekitUserEndpoint.changePassword} event       |           |
+ * | -------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------- | --------------------------------------------------------------- | --------- |
+ * | configureFactor2Endpoint   | Configure secrets for user's factor2                       | Just `baseEndpoint` data                                                     | `default`:                                                       | `default`:                                                      |           |
+ * |                            |                                                            |                                                                              |  - see {@link SveltekitUserEndpoint.configureFactor2} return     |  - see {@link SveltekitUserEndpoint.configureFactor2} event     |           |
+ * | -------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------- | --------------------------------------------------------------- | --------- |
+ * | deleteUserEndpoint         | Delete the logged in user                                  | Just `baseEndpoint` data                                                     | `default`:                                                       | `default`:                                                      |           |
+ * |                            |                                                            |                                                                              |  - see {@link SveltekitUserEndpoint.deleteUser} return           |  - see {@link SveltekitUserEndpoint.deleteUser} event           |           |
+ * | -------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------- | --------------------------------------------------------------- | --------- |
+ * | resetPasswordEndpoint      | Requests and password reset and emails token to user       | - `next` page to redirect to on ok                                      | `default`:                                                       | `default`:                                                      |           |
+ * |                            |                                                            | - `required` if true, this was called because the user must                  |  - see {@link SveltekitUserEndpoint.requestPasswordReset} return |  - see {@link SveltekitUserEndpoint.requestPasswordReset} event |           |
+ * |                            |                                                            |                                                                              |                                                                  |                                                                 |           |
+ * | -------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------- | --------------------------------------------------------------- | --------- |
+ * | passwordResetTokenEndpoint | Validates emailed token and executes a password reset      | - `tokenValidates` true if the token is valid                                | `default`:                                                       | `default`:                                                      | `token`   |
+ * |                            |                                                            | - `error` error message if token is not valid                                |  - see {@link SveltekitUserEndpoint.resetPassword} return        |  - see {@link SveltekitUserEndpoint.resetPassword} event        |           |
+ * | -------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------- | --------------------------------------------------------------- | --------- |
+ * | updateUserEndpoint         | Update currently-logged in user's details                  | - `allowedFactor2` see PageData for `signupEndpoint`                         | `default`:                                                       | `default`:                                                      |           |
+ * |                            |                                                            | - `required` if true, this was called because the user must                  |  - see {@link SveltekitUserEndpoint.updateUser} return           |  - see {@link SveltekitUserEndpoint.updateUser} event           |           |
+ * | -------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------- | --------------------------------------------------------------- | --------- |
+ * | verifyEmailTokenEndpoint   | Validates an email verification token emailed to user      | - `user` corresponding {@link @crossauth/common!User} if token is valid      | *None provided*                                                  |                                                                 | `token`   |
+ * |                            |                                                            | - `error` error message if token validation failed                           |                                                                  |                                                                 |           |
+ * |                            |                                                            | - `ok` true if validation was successful, false otherwise               |                                                                  |                                                                 |           |
+ */
+export declare class SvelteKitUserEndpoints {
+    private sessionServer;
+    private changePasswordUrl;
+    private changeFactor2Url;
+    private requestPasswordResetUrl;
+    private loginRedirectUrl;
+    private loginUrl;
+    private addToSession?;
+    constructor(sessionServer: SvelteKitSessionServer, options: SvelteKitSessionServerOptions);
+    /** Returns whether there is a user logged in with a cookie-based session
+     */
+    isSessionUser(event: RequestEvent): boolean;
+    /**
+     * A user can edit his or her account if they are logged in with
+     * session management, or are logged in with some other means and
+     * e`ditUserScope` has been set and is included in the user's scopes.
+     * @param request the Fastify request
+     * @returns true or false
+     */
+    canEditUser(event: RequestEvent): boolean | "" | undefined;
+    /**
+     * Log a user in if possible.
+     *
+     * Form data is returned unless there was
+     * an error extrafting it.  User is returned if log in was successful.
+     * Error messge and exception are returned if not successful.
+     *
+     * @param event the Sveltekit event.  The fields needed are:
+     *
+     *   - `username`.
+     *   - *secrets* (eg `password`).
+     *   - `repeat_`*secrets* (eg `repeat_password`).
+     *
+     *   The secrets are authenticator-dependent.
+     *
+     * @returns object with:
+     *
+     *   - `success` true if login was successful, false otherwise.
+     *     even if factor2 authentication is required, this will still
+     *     be true if there was no error.
+     *   - `user` the user if login was successful
+     *   - `formData` the form fields extracted from the request
+     *   - `error` an error message or undefined
+     *   - `exception` a {@link @crossauth/common!CrossauthError} if an
+     *     exception was raised
+     *   - `factor2Required` if true, second factor authentication is needed
+     *     to complete login
+     */
+    login(event: RequestEvent): Promise<LoginReturn>;
+    /**
+     * This is called after the user has been validated to log the user in
+     */
+    private loginWithUser;
+    /**
+     * Log a user out.
+     *
+     * Deletes the session if the user was logged in and clears session
+     * and CSRF cookies (if CSRF protection is enabled)
+     *
+     * @param event the Sveltekit event
+     *
+     * @returns object with:
+     *
+     *   - `success` true if logout was successful, false otherwise.
+     *   - `error` an error message or undefined
+     *   - `exception` a {@link @crossauth/common!CrossauthError} if an
+     *     exception was raised
+     */
+    logout(event: RequestEvent): Promise<LogoutReturn>;
+    /**
+     * Creates an account.
+     *
+     * Form data is returned unless there was an error extrafting it.
+     *
+     * Initiates user login if creation was successful.
+     *
+     * If login was successful, no factor2 is needed
+     * and no email verification is needed, the user is returned.
+     *
+     * If email verification is needed, `emailVerificationRequired` is
+     * returned as `true`.
+     *
+     * If factor2 configuration is required, `factor2Required` is returned
+     * as `true`.
+     *
+     * @param event the Sveltekit event.  The form fields used are
+     *   - `username` the desired username
+     *   - `factor2` which must be in the `allowedFactor2` option passed
+     *     to the constructor.
+     *   - *secrets* (eg `password`) which are factor1 authenticator specific
+     *   - `repeat_`*secrets* (eg `repeat_password`)
+     *   - `user_*` anything prefixed with `user` that is also in
+     *   - the `userEditableFields` option passed when constructing the
+     *     user storage object will be added to the {@link @crossuath/common!User}
+     *     object (with `user_` removed).
+     *
+     * @returns object with:
+     *
+     *   - `ok` true if creation and login were successful,
+     *      false otherwise.
+     *     even if factor2 authentication is required, this will still
+     *     be true if there was no error.
+     *   - `user` the user if login was successful
+     *   - `formData` the form fields extracted from the request
+     *   - `error` an error message or undefined
+     *   - `exception` a {@link @crossauth/common!CrossauthError} if an
+     *     exception was raised
+     *   - `factor2Required` if true, second factor authentication is needed
+     *     to complete login
+     *   - `factor2Data` contains data that needs to be passed to the user's
+     *      chosen factor2 authenticator
+     *   - `emailVerificationRequired` if true, the user needs to click on
+     *     the link emailed to them to complete signup.
+     */
+    signup(event: RequestEvent): Promise<SignupReturn>;
+    /**
+     * Takes email verification token from the params on the URL and attempts
+     * email verification.
+     *
+     * @param event the Sveltekit event.  This should contain the URL
+     *        parameter called `token`
+     *
+     * @returns object with:
+     *
+     *   - `ok` true if creation and login were successful,
+     *      false otherwise.
+     *     even if factor2 authentication is required, this will still
+     *     be true if there was no error.
+     *   - `user` the user if successful
+     *   - `formData` the form fields extracted from the request
+     *   - `error` an error message or undefined
+     *   - `exception` a {@link @crossauth/common!CrossauthError} if an
+     *     exception was raised
+     *   - `factor2Required` if true, second factor authentication is needed
+     *     to complete login
+     *   - `factor2Data` contains data that needs to be passed to the user's
+     *      chosen factor2 authenticator
+     *   - `emailVerificationRequired` if true, the user needs to click on
+     *     the link emailed to them to complete signup.
+     */
+    verifyEmail(event: RequestEvent): Promise<VerifyEmailReturn>;
+    /**
+     * Completes factor2 configuration.
+     *
+     * 2FA configuration is initiated with {@link signup()}, or
+     * {@link changeFactor2()}.  If these return successfully, call this
+     * function.
+     *
+     * @param event the Sveltekit event.  This should contain fields
+     *        required by the user's chosen authenticator.
+     *
+     * @returns object with:
+     *
+     *   - `success` true if creation and login were successful,
+     *      false otherwise.
+     *   - `user` the user successful
+     *   - `error` an error message or undefined
+     *   - `exception` a {@link @crossauth/common!CrossauthError} if an
+     *     exception was raised
+     *   - `emailVerificationRequired` if true, the user needs to click on
+     *     the link emailed to them to complete configuration.
+     */
+    configureFactor2(event: RequestEvent): Promise<ConfigureFactor2Return>;
+    /**
+     * Call this when `login()` returns `factor2Required = true`
+     *
+     * @param event the Sveltekit event.  The fields needed are those
+     *        required by the factor2 authenticator.
+     *
+     * @returns object with:
+     *
+     *   - `success` true if login was successful, false otherwise.
+     *   - `user` the user if login was successful
+     *   - `formData` the form fields extracted from the request
+     *   - `error` an error message or undefined
+     *   - `exception` a {@link @crossauth/common!CrossauthError} if an
+     *     exception was raised
+     */
+    loginFactor2(event: RequestEvent): Promise<LoginReturn>;
+    requestPasswordReset(event: RequestEvent): Promise<RequestPasswordResetReturn>;
+    /**
+     * Call this from the GET url the user clicks on to reset their password.
+     *
+     * If it is enabled, fetches the user for the token to confirm the token
+     * is valid.
+
+     * @param event the Sveltekit event.  This should a `token` URL parameter.
+
+     * @returns object with:
+     *
+     *   - `ok` true if creation and login were successful,
+     *      false otherwise.
+     *   - `user` the user successful
+     *   - `error` an error message or undefined
+     *   - `exception` a {@link @crossauth/common!CrossauthError} if an
+     *     exception was raised
+     *   - `formData` the form fields extracted from the request
+     */
+    validatePasswordResetToken(event: RequestEvent): Promise<ResetPasswordReturn>;
+    /**
+     * Call this from the POST url the user uses to fill in a new password
+     * after validating the token in the GET url with
+     * {@link validatePasswordResetToken}.
+     *
+     * @param event the Sveltekit event.  This should contain
+     *   - `new_`*secrets` (eg `new_password`) the new secret.
+     *   - `repeat_`*secrets` (eg `repeat_password`) repeat of the new secret.
+
+     * @returns object with:
+     *
+     *   - `ok` true if creation and login were successful,
+     *      false otherwise.
+     *   - `user` the user if successful
+     *   - `error` an error message or undefined
+     *   - `exception` a {@link @crossauth/common!CrossauthError} if an
+     *     exception was raised
+     *   - `formData` the form fields extracted from the request
+     */
+    resetPassword(event: RequestEvent): Promise<ResetPasswordReturn>;
+    /**
+     * Call this from your factor2 endpoint to fetch the data needed to
+     * display the factor2 form.
+     *
+     * This can only be called after 2FA has been initiated by visiting
+     * a page with factor2 protection, as defined by the
+     * `factor2ProtectedPageEndpoints` and `factor2ProtectedApiEndpoints`
+     * defined when constructing this class.
+     *
+     * @param event the Sveltekit event.
+
+     * @returns object with:
+     *
+     *   - `ok` true if creation and login were successful,
+     *      false otherwise.
+     *   - `action` the URL to load on ok.  This was the one originally
+     *     requested by the user before being redirected to 2FA authentication.
+     *   - `factor2` the user's factor2
+     *   - `error` an error message or undefined
+     *   - `exception` a {@link @crossauth/common!CrossauthError} if an
+     *     exception was raised
+     */
+    requestFactor2(event: RequestEvent): Promise<RequestFactor2Return>;
+    /**
+     * Call this with POST data to change the logged-in user's password
+     *
+     * @param event the Sveltekit event.  This should contain
+     *   - `old_`*secrets` (eg `old_password`) the existing secret.
+     *   - `new_`*secrets` (eg `new_password`) the new secret.
+     *   - `repeat_`*secrets` (eg `repeat_password`) repeat of the new secret.
+
+     * @returns object with:
+     *
+     *   - `ok` true if creation and login were successful,
+     *      false otherwise.
+     *   - `user` the user if successful
+     *   - `error` an error message or undefined
+     *   - `exception` a {@link @crossauth/common!CrossauthError} if an
+     *     exception was raised
+     *   - `formData` the form fields extracted from the request
+     */
+    changePassword(event: RequestEvent): Promise<ChangePasswordReturn>;
+    /**
+     * Call this to delete the logged-in user
+     *
+     * @param event the Sveltekit event.
+
+     * @returns object with:
+     *
+     *   - `ok` true if creation and login were successful,
+     *      false otherwise.
+     *   - `error` an error message or undefined
+     *   - `exception` a {@link @crossauth/common!CrossauthError} if an
+     *     exception was raised
+     */
+    deleteUser(event: RequestEvent): Promise<DeleteUserReturn>;
+    /**
+     * Call this to update a user's details (apart from password and factor2)
+     *
+     * @param event the Sveltekit event.  The form fields used are
+     *   - `username` the desired username
+     *   - `user_*` anything prefixed with `user` that is also in
+     *     the `userEditableFields` option passed when constructing the
+     *     user storage object will be added to the {@link @crossuath/common!User}
+     *     object (with `user_` removed).
+     *
+     * @returns object with:
+     *
+     *   - `ok` true if creation and login were successful,
+     *      false otherwise.
+     *     even if factor2 authentication is required, this will still
+     *     be true if there was no error.
+     *   - `user` the user if login was successful
+     *   - `formData` the form fields extracted from the request
+     *   - `error` an error message or undefined
+     *   - `exception` a {@link @crossauth/common!CrossauthError} if an
+     *     exception was raised
+     *   - `emailVerificationRequired` if true, the user needs to click on
+     *     the link emailed to them to complete signup.
+     */
+    updateUser(event: RequestEvent): Promise<UpdateUserReturn>;
+    /**
+     * Call this to change the logged in user's factor2.
+     *
+     * @param event the Sveltekit event.  The form fields used are
+     *   - `factor2` the new designed factor2, which must be in
+     *     the `allowedFactor2` option passed to the constructor.
+     *
+     * @returns object with:
+     *
+     *   - `ok` true if creation and login were successful,
+     *      false otherwise.
+     *     even if factor2 authentication is required, this will still
+     *     be true if there was no error.
+     *   - `user` the user if login was successful
+     *   - `formData` the form fields extracted from the request
+     *   - `error` an error message or undefined
+     *   - `exception` a {@link @crossauth/common!CrossauthError} if an
+     *     exception was raised
+     *   - `factor2Data` the data to pass to the factor2 configuration page.
+     */
+    changeFactor2(event: RequestEvent): Promise<ChangeFactor2Return>;
+    /**
+     * Call this to reconfigure the current factor2 type.
+     *
+     * @param event the Sveltekit event.
+     *
+     * @returns object with:
+     *
+     *   - `ok` true if creation and login were successful,
+     *      false otherwise.
+     *     even if factor2 authentication is required, this will still
+     *     be true if there was no error.
+     *   - `user` the user if login was successful
+     *   - `formData` the form fields extracted from the request
+     *   - `error` an error message or undefined
+     *   - `exception` a {@link @crossauth/common!CrossauthError} if an
+     *     exception was raised
+     *   - `factor2Data` the data to pass to the factor2 configuration page.
+     */
+    reconfigureFactor2(event: RequestEvent): Promise<ChangeFactor2Return>;
+    baseEndpoint(event: RequestEvent): {
+        user: User | undefined;
+        csrfToken: string | undefined;
+    };
+    readonly signupEndpoint: {
+        load: (event: RequestEvent) => Promise<{
+            user: User | undefined;
+            csrfToken: string | undefined;
+            allowedFactor2: {
+                name: string;
+                friendlyName: string;
+                configurable: boolean;
+            }[];
+        }>;
+        actions: {
+            default: (event: RequestEvent) => Promise<SignupReturn>;
+        };
+    };
+    readonly loginEndpoint: {
+        load: (event: RequestEvent) => Promise<{
+            user: User | undefined;
+            csrfToken: string | undefined;
+            next: string;
+        }>;
+        actions: {
+            login: (event: RequestEvent) => Promise<LoginReturn>;
+            factor2: (event: RequestEvent) => Promise<LoginReturn>;
+        };
+    };
+    readonly factor2Endpoint: {
+        load: (event: RequestEvent) => Promise<RequestFactor2Return>;
+    };
+    readonly logoutEndpoint: {
+        actions: {
+            default: (event: RequestEvent) => Promise<LogoutReturn>;
+        };
+        load: (event: RequestEvent) => Promise<{
+            user: User | undefined;
+            csrfToken: string | undefined;
+        }>;
+    };
+    readonly changeFactor2Endpoint: {
+        actions: {
+            change: (event: RequestEvent) => Promise<ChangeFactor2Return>;
+            reconfigure: (event: RequestEvent) => Promise<ChangeFactor2Return>;
+        };
+        load: (event: RequestEvent) => Promise<{
+            user: User | undefined;
+            csrfToken: string | undefined;
+            username: string | undefined;
+            required?: boolean | undefined;
+            next?: string | undefined;
+            allowedFactor2: {
+                name: string;
+                friendlyName: string;
+                configurable: boolean;
+            }[];
+        }>;
+    };
+    readonly changePasswordEndpoint: {
+        actions: {
+            default: (event: RequestEvent) => Promise<ChangePasswordReturn>;
+        };
+        load: (event: RequestEvent) => Promise<{
+            user: User | undefined;
+            csrfToken: string | undefined;
+            required?: boolean | undefined;
+            next?: string | undefined;
+        }>;
+    };
+    readonly configureFactor2Endpoint: {
+        actions: {
+            default: (event: RequestEvent) => Promise<ConfigureFactor2Return>;
+        };
+        load: (event: RequestEvent) => Promise<{
+            user: User | undefined;
+            csrfToken: string | undefined;
+        }>;
+    };
+    readonly deleteUserEndpoint: {
+        actions: {
+            default: (event: RequestEvent) => Promise<DeleteUserReturn>;
+        };
+        load: (event: RequestEvent) => Promise<{
+            user: User | undefined;
+            csrfToken: string | undefined;
+        }>;
+    };
+    readonly resetPasswordEndpoint: {
+        actions: {
+            default: (event: RequestEvent) => Promise<RequestPasswordResetReturn>;
+        };
+        load: (event: RequestEvent) => Promise<{
+            user: User | undefined;
+            csrfToken: string | undefined;
+            required?: boolean | undefined;
+            next?: string | undefined;
+        }>;
+    };
+    readonly passwordResetTokenEndpoint: {
+        actions: {
+            default: (event: RequestEvent) => Promise<ResetPasswordReturn>;
+        };
+        load: (event: RequestEvent) => Promise<{
+            user: User | undefined;
+            csrfToken: string | undefined;
+            tokenValidated: boolean;
+            error: string | undefined;
+        }>;
+    };
+    readonly updateUserEndpoint: SveltekitEndpoint;
+    readonly verifyEmailTokenEndpoint: SveltekitEndpoint;
+}