@crossauth/sveltekit 0.0.2

package/dist/sveltekitadminclientendpoints.d.ts

@@ -0,0 +1,150 @@
+import { SvelteKitSessionServer, SvelteKitSessionServerOptions } from './sveltekitsession';
+import { RequestEvent } from '@sveltejs/kit';
+import { SvelteKitSharedClientEndpoints, SearchClientsPageData, UpdateClientPageData, UpdateClientFormData, DeleteClientPageData, DeleteClientFormData } from './sveltekitsharedclientendpoints';
+
+/**
+ * Endpoints for manipulating the OAuth client table, for use by admins.
+ *
+ * You do not instantiate this directly - it is created when you create
+ * a {@link SvelteKitServer}.
+ *
+ * **Endpoints**
+ *
+ * These endpoints can only be called if an admin user is logged in, as defined
+ * by the {@link SveltekitSessionServer.isAdminFn}.  If the user does not
+ * have this permission, a 401 error is raised.
+ *
+ * | 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                |
+ * | -------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | --------- |
+ * | searchClientsEndpoint      | Returns a paginated set of clients or those matching search | See {@link SearchClientsPageData}                                                | *Not provided*                                                   |                                                                  |           |
+ * | -------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | --------- |
+ * | updateClientEndpoint       | Updates a client                                            | See {@link UpdateClientsPageData}                                                | `default`:                                                       |                                                                  |           |
+ * |                            |                                                             |                                                                                  | See {@link UpdateClientsFormData}                                | See {@link SvelteKitSharedClientEndpoints.updateClient_internal} | client_id  |
+ * | -------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | --------- |
+ * | createClientEndpoint       | Creates a new client                                        | See {@link CreateClientsPageData}                                                | `default`:                                                       |                                                                  |           |
+ * |                            |                                                             |                                                                                  | See {@link CreateClientsFormData}                                | See {@link SvelteKitSharedClientEndpoints.createClient_internal} | client_id  |
+ * | -------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | --------- |
+ * | deleteClientEndpoint       | Deletes a client                                            | See {@link DeleteClientsPageData}                                                | `default`:                                                       |                                                                  |           |
+ * |                            |                                                             |                                                                                  | See {@link DeleteClientsFormData}                                | See {@link SvelteKitSharedClientEndpoints.deleteClient_internal} | client_id  |
+ * | -------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | --------- |
+ */
+export declare class SvelteKitAdminClientEndpoints extends SvelteKitSharedClientEndpoints {
+    /**
+     * Constructor
+     * @param sessionServer the session server which will have these endpoints
+     * @param options See {@link SvelteKitSessionServerOptions}.
+     */
+    constructor(sessionServer: SvelteKitSessionServer, options: SvelteKitSessionServerOptions);
+    /**
+     * See {@link SvelteKitSharedClientEndpoints.searchClients_internal}
+     */
+    searchClients(event: RequestEvent, searchTerm?: string, skip?: number, take?: number, userid?: number | string): Promise<SearchClientsPageData>;
+    /**
+     * See {@link SvelteKitSharedClientEndpoints.loadClient_internal}
+     */
+    loadClient(event: RequestEvent): Promise<UpdateClientPageData>;
+    /**
+     * See {@link SvelteKitSharedClientEndpoints.updateClient_internal}
+     */
+    updateClient(event: RequestEvent): Promise<UpdateClientFormData>;
+    /**
+     * See {@link SvelteKitSharedClientEndpoints.emptyClient_internal}
+     */
+    emptyClient(event: RequestEvent): Promise<UpdateClientPageData>;
+    /**
+     * See {@link SvelteKitSharedClientEndpoints.createClient_internal}
+     */
+    createClient(event: RequestEvent): Promise<UpdateClientFormData>;
+    /**
+     * See {@link SvelteKitSharedClientEndpoints.loadDeleteClient_internal}
+     */
+    loadDeleteClient(event: RequestEvent): Promise<DeleteClientPageData>;
+    /**
+     * See {@link SvelteKitSharedClientEndpoints.deleteClient_internal}
+     */
+    deleteClient(event: RequestEvent): Promise<DeleteClientFormData>;
+    /**
+     * See class documentation.
+     */
+    readonly searchClientsEndpoint: {
+        load: (event: RequestEvent) => Promise<{
+            ok: boolean;
+            clients?: import('@crossauth/common').OAuthClient[] | undefined;
+            skip: number;
+            take: number;
+            search?: string | undefined;
+            error?: string | undefined;
+            exception?: import('@crossauth/common').CrossauthError | undefined;
+            hasPrevious: boolean;
+            hasNext: boolean;
+            clientUserId?: string | number | undefined;
+            user: import('@crossauth/common').User | undefined;
+            csrfToken: string | undefined;
+        }>;
+    };
+    /**
+     * See class documentation.
+     */
+    readonly updateClientEndpoint: {
+        load: (event: RequestEvent) => Promise<{
+            ok: boolean;
+            client?: import('@crossauth/common').OAuthClient | undefined;
+            client_id?: string | undefined;
+            clientUsername?: string | undefined;
+            error?: string | undefined;
+            exception?: import('@crossauth/common').CrossauthError | undefined;
+            validFlows: string[];
+            valid_flowNames: {
+                [key: string]: string;
+            };
+            user: import('@crossauth/common').User | undefined;
+            csrfToken: string | undefined;
+        }>;
+        actions: {
+            default: (event: RequestEvent) => Promise<UpdateClientFormData>;
+        };
+    };
+    /**
+     * See class documentation.
+     */
+    readonly createClientEndpoint: {
+        load: (event: RequestEvent) => Promise<{
+            ok: boolean;
+            client?: import('@crossauth/common').OAuthClient | undefined;
+            client_id?: string | undefined;
+            clientUsername?: string | undefined;
+            error?: string | undefined;
+            exception?: import('@crossauth/common').CrossauthError | undefined;
+            validFlows: string[];
+            valid_flowNames: {
+                [key: string]: string;
+            };
+            user: import('@crossauth/common').User | undefined;
+            csrfToken: string | undefined;
+        }>;
+        actions: {
+            default: (event: RequestEvent) => Promise<UpdateClientFormData>;
+        };
+    };
+    /**
+     * See class documentation.
+     */
+    readonly deleteClientEndpoint: {
+        load: (event: RequestEvent) => Promise<{
+            ok: boolean;
+            client?: import('@crossauth/common').OAuthClient | undefined;
+            client_id?: string | undefined;
+            clientUsername?: string | undefined;
+            error?: string | undefined;
+            exception?: import('@crossauth/common').CrossauthError | undefined;
+            user: import('@crossauth/common').User | undefined;
+            csrfToken: string | undefined;
+        }>;
+        actions: {
+            default: (event: RequestEvent) => Promise<DeleteClientFormData>;
+        };
+    };
+}

package/dist/sveltekitadminendpoints.d.ts

@@ -0,0 +1,369 @@
+import { SvelteKitSessionServer, SvelteKitSessionServerOptions } from './sveltekitsession';
+import { User, UserInputFields, CrossauthError } from '@crossauth/common';
+import { RequestEvent } from '@sveltejs/kit';
+
+/**
+ * Return type for {@link SvelteKitAdminEndpoints.updateUser}
+ * {@link SvelteKitAdminEndpoints.updateUserEndpoint} action.
+ *
+ * See class documentation for {@link SvelteKitUserEndpoints} for more details.
+ */
+export type AdminUpdateUserReturn = {
+    user?: User;
+    error?: string;
+    exception?: CrossauthError;
+    formData?: {
+        [key: string]: string;
+    };
+    ok: boolean;
+};
+/**
+ * Return type for {@link SvelteKitAdminEndpoints.changePassword}
+ * {@link SvelteKitAdminEndpoints.changePasswordEndpoint} action.
+ *
+ * See class documentation for {@link SvelteKitUserEndpoints} for more details.
+ */
+export type AdminChangePasswordReturn = {
+    user?: User;
+    error?: string;
+    exception?: CrossauthError;
+    formData?: {
+        [key: string]: string;
+    };
+    ok: boolean;
+};
+/**
+ * Return type for {@link SvelteKitAdminEndpoints.createUser}
+ * {@link SvelteKitAdminEndpoints.createUserEndpoint} action.
+ *
+ * See class documentation for {@link SvelteKitUserEndpoints} for more details.
+ */
+export type AdminCreateUserReturn = {
+    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;
+};
+/**
+ * Return type for {@link SvelteKitAdminEndpoints.deleteUser}
+ * {@link SvelteKitAdminEndpoints.deleteUserEndpoint} action.
+ *
+ * See class documentation for {@link SvelteKitUserEndpoints} for more details.
+ */
+export type AdminDeleteUserReturn = {
+    user?: User;
+    error?: string;
+    exception?: CrossauthError;
+    ok: boolean;
+};
+/**
+ * Return type for {@link SvelteKitAdminEndpoints.searchUsers}
+ * {@link SvelteKitAdminEndpoints.searchUsersEndpoint} action.
+ *
+ * See class documentation for {@link SvelteKitUserEndpoints} for more details.
+ */
+export type SearchUsersReturn = {
+    ok: boolean;
+    users?: User[];
+    skip: number;
+    take: number;
+    search?: string;
+    error?: string;
+    exception?: CrossauthError;
+    hasPrevious: boolean;
+    hasNext: 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.adminEndpoints`.
+ *
+ * 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 updateUser} or use
+ * the `action` and `load` members of the endpoint objects.
+ * For example, for {@link updateUserEndpoint}
+ *
+ * ```
+ * export const load = crossauth.sessionServer?.adminEndpoints.updateUserEndpoint.load ?? crossauth.dummyLoad;
+ * export const actions = crossauth.sessionServer?.adminEndpoints.updateUserEndpoint.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**
+ *
+ * These endpoints can only be called if an admin user is logged in, as defined
+ * by the {@link SveltekitSessionServer.isAdminFn}.  If the user does not
+ * have this permission, a 401 error is raised.
+ *
+ * | 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                |
+ * | -------------------------- | ---------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ----------------------------------------------------------- | --------- |
+ * | searchUsersEndpoint        | Returns a paginated set of users or those matchign search  | See return of {@link SvelteKitAdminEndpoints.searchUsers}                        | *Not provided*                                                   |                                                             |           |
+ * | -------------------------- | ---------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ----------------------------------------------------------- | --------- |
+ * | updateUserEndpoint         | Update a user's details                                    | - `allowedFactor2` see {@link SvelteKitAdminEndpoints}.`signupEndpoint`          | `default`:                                                       | `default`:                                                  | `id`      |
+ * |                            |                                                            | - `editUser` the {@link @crossauth/common!User} being edited                     |  - see {@link SveltekitAdminEndpoint.updateUser} return          |  - see {@link SveltekitAdminEndpoint.updateUser} event      |           |
+ * | -------------------------- | ---------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ----------------------------------------------------------- | --------- |
+ * | changePasswordEndpoint     | Update a user's password                                   | - `next` page to load on szccess                                                 | `default`:                                                       | `default`:                                                  | `id`      |
+ * |                            |                                                            | - `editUser` the {@link @crossauth/common!User} being edited                     |  - see {@link SveltekitAdminEndpoint.changePassword} return      |  - see {@link SveltekitAdminEndpoint.changePassword} event  |           |
+ * | -------------------------- | ---------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ----------------------------------------------------------- | --------- |
+ * | createUserEndpoint         | Creates a new user                                         | - `allowedFactor2` see {@link SvelteKitAdminEndpoints}.`signupEndpoint`          | `default`:                                                       | `default`:                                                  | `id`      |
+ * |                            |                                                            |                                                                                  |  - see {@link SveltekitAdminEndpoint.createUser} return          |  - see {@link SveltekitAdminEndpoint.createUser} event      |           |
+ * | -------------------------- | ---------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ----------------------------------------------------------- | --------- |
+ * | deleteUser                 | Deletes a user                                             | - `error` error message if user ID doesn't exist                                 | `default`:                                                       | `default`:                                                  | `id`      |
+ * |                            |                                                            |                                                                                  |  - see {@link SveltekitAdminEndpoint.deleteUser} return          |  - see {@link SveltekitAdminEndpoint.deleteUser} event      |           |
+ */
+export declare class SvelteKitAdminEndpoints {
+    private sessionServer;
+    private userSearchFn;
+    constructor(sessionServer: SvelteKitSessionServer, options: SvelteKitSessionServerOptions);
+    /** Returns whether there is a user logged in with a cookie-based session
+     */
+    isSessionUser(event: RequestEvent): boolean;
+    /**
+     * Returns either a list of all users or users matching a search term.
+     *
+     * The returned list is pagenaed using the `skip` and `take` parameters.
+     *
+     * The searching is done with `userSearchFn` that was passed in the
+     * options (see {@link SvelteKitSessionServerOptions }).  THe default
+     * is an exact username match.
+     *
+     * By default, the searh and pagination parameters are taken from
+     * the query parameters in the request but can be overridden.
+     *
+     * @param event the Sveltekit request event.  The following query parameters
+     *        are read:
+     *   - `search` the search term which is ignored if it is undefined, null
+     *      or the empty string.
+     *   - `skip` the number to start returning from.  0 if not defined
+     *   - `take` the maximum number to return.  10 if not defined.
+     * @param search overrides the search term from the query.
+     * @param skip overrides the skip term from the query
+     * @param take overrides the take term from the query
+     *
+     * @return an object with the following members:
+     *   - `ok` true or false depending on whether there was an error
+     *   - `users` the matching array of users
+     *   - `error` error message if `ok` is false
+     *   - `exception` a {@link @crossauth/common!CrossauthError} if there was
+     *      an error.
+     *   - `search` the search term that was used
+     *   - `skip` the skip term that was used
+     *   - `take` the take term that was used
+     *   - `hasNext` whether there are still more results after the ones that
+     *      were returned
+     *   - `hasPrevious` whether there are more results before the ones that
+     *      were returned.
+     */
+    searchUsers(event: RequestEvent, searchTerm?: string, skip?: number, take?: number): Promise<SearchUsersReturn>;
+    /**
+     * Call this to update a user's details.
+     *
+     * If you try updating factor2, the user will be asked to reset factor2
+     * upon next login.
+     *
+     * If you do not set a password, user will be sent a password reset
+     * token to set a new one.
+     *
+     * @param event the Sveltekit event.  The form fields used are
+     *   - `username` the desired username
+     *   - `factor2` the desiredf second factor
+     *   - `state` the desired state, which will be overridden if the
+     *     user has to reset password and/or factor2
+     *   - `user_*` anything prefixed with `user` that is also in
+     *     the `userEditableFields` or `adminEditableFields` options
+     *     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.
+     *   - `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
+     */
+    updateUser(user: User, event: RequestEvent): Promise<AdminUpdateUserReturn>;
+    /**
+     * Call this with POST data to change the logged-in user's password
+     *
+     * @param user the user to edit
+     * @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(user: User, event: RequestEvent): Promise<AdminChangePasswordReturn>;
+    /**
+     * 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.
+     */
+    createUser(event: RequestEvent): Promise<AdminCreateUserReturn>;
+    /**
+     * Call this to delete the logged-in user
+     *
+     * @param userid the user to delete
+     * @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<AdminDeleteUserReturn>;
+    baseEndpoint(event: RequestEvent): {
+        user: User | undefined;
+        csrfToken: string | undefined;
+    };
+    readonly searchUsersEndpoint: {
+        load: (event: RequestEvent) => Promise<{
+            ok: boolean;
+            users?: User[] | undefined;
+            skip: number;
+            take: number;
+            search?: string | undefined;
+            error?: string | undefined;
+            exception?: CrossauthError | undefined;
+            hasPrevious: boolean;
+            hasNext: boolean;
+            user: User | undefined;
+            csrfToken: string | undefined;
+        }>;
+    };
+    private getUserFromParam;
+    readonly updateUserEndpoint: {
+        actions: {
+            default: (event: RequestEvent) => Promise<AdminUpdateUserReturn>;
+        };
+        load: (event: RequestEvent) => Promise<{
+            user: User | undefined;
+            csrfToken: string | undefined;
+            allowedFactor2: {
+                name: string;
+                friendlyName: string;
+                configurable: boolean;
+            }[];
+            editUser: User | undefined;
+        }>;
+    };
+    readonly changePasswordEndpoint: {
+        actions: {
+            default: (event: RequestEvent) => Promise<AdminChangePasswordReturn>;
+        };
+        load: (event: RequestEvent) => Promise<{
+            user: User | undefined;
+            csrfToken: string | undefined;
+            editUser: User | undefined;
+        } | {
+            user: User | undefined;
+            csrfToken: string | undefined;
+            editUser: User;
+            next?: string | undefined;
+        }>;
+    };
+    readonly createUserEndpoint: {
+        load: (event: RequestEvent) => Promise<{
+            user: User | undefined;
+            csrfToken: string | undefined;
+            allowedFactor2: {
+                name: string;
+                friendlyName: string;
+                configurable: boolean;
+            }[];
+        }>;
+        actions: {
+            default: (event: RequestEvent) => Promise<AdminCreateUserReturn>;
+        };
+    };
+    readonly deleteUserEndpoint: {
+        actions: {
+            default: (event: RequestEvent) => Promise<AdminDeleteUserReturn>;
+        };
+        load: (event: RequestEvent) => Promise<{
+            user: User | undefined;
+            csrfToken: string | undefined;
+            error: string;
+        } | {
+            user: User | undefined;
+            csrfToken: string | undefined;
+            username: string;
+        }>;
+    };
+}

package/dist/sveltekitapikey.d.ts

@@ -0,0 +1,48 @@
+import { UserStorage, KeyStorage, ApiKeyManagerOptions } from '@crossauth/backend';
+import { RequestEvent, MaybePromise } from '@sveltejs/kit';
+
+/**
+ * Options for {@link SvelteKitApiKeyServer }.
+ *
+ * See {@link SveltekitApiKeyServer } constructor for description of parameters
+ */
+export interface SvelteKitApiKeyServerOptions extends ApiKeyManagerOptions {
+    /** Pass the Sveltekit redirect function */
+    redirect?: any;
+    /** Pass the Sveltekit error function */
+    error?: any;
+}
+/**
+ * This class adds API key functionality to the Fatify server.
+ *
+ * You shouldn't have to instantiate this directly.  It is created
+ * when instantiating {@link SvelteKitServer} if enabling API key support-
+ *
+ * API keys are bearer tokens than have to be manually created for a user.
+ * They can be used in place of username/password login and session cookies.
+ *
+ * This class adds a `preHandler` hook that sets the `user` field in the
+ * Fastify request.  It also sets `scopes` in the request object if there
+ * is a `scope` field in the JSON object in the `data` field in in the API
+ * record in key storage.
+ */
+export declare class SvelteKitApiKeyServer {
+    private userStorage;
+    private apiKeyManager;
+    /**
+     * Hook to check if the user is logged in and set data in `locals`
+     * accordingly.
+     */
+    readonly hook: (input: {
+        event: RequestEvent;
+    }) => MaybePromise<void>;
+    /**
+     * Constructor
+     *
+     * @param app the Fastify app instance
+     * @param userStorage the user storage with user accounts
+     * @param keyStorage the storage for finding API keys
+     * @param options See {@link FastifyApiKeyServerOptions}
+     */
+    constructor(userStorage: UserStorage, keyStorage: KeyStorage, options?: SvelteKitApiKeyServerOptions);
+}