@crossauth/fastify 0.0.2

package/dist/fastifysessionadapter.d.ts

@@ -0,0 +1,48 @@
+import { FastifyRequest } from 'fastify';
+import { User } from '@crossauth/common';
+
+export declare abstract class FastifySessionAdapter {
+    abstract csrfProtectionEnabled(): boolean;
+    abstract getCsrfToken(request: FastifyRequest): string | undefined;
+    abstract getUser(request: FastifyRequest): User | undefined;
+    /**
+     * Updates a field in the session data in the key storage record,
+     *
+     * The `data` field is assumed to be JSON.  Just the field with the given
+     * name is updated and the rest is unchanged.
+     * @param request the Fastifdy request
+     * @param name the field within `data` to update
+     * @param value the value to set it to
+     */
+    abstract updateSessionData(request: FastifyRequest, name: string, value: any): Promise<void>;
+    /**
+     * Same as `updateData` but updates many within same transaction
+     *
+     * The `data` field is assumed to be JSON.  Just the field with the given
+     * name is updated and the rest is unchanged.
+     * @param request the Fastifdy request
+     * @param dataArray data to update
+     */
+    abstract updateManySessionData(request: FastifyRequest, dataArray: {
+        dataName: string;
+        value: any;
+    }[]): Promise<void>;
+    /**
+    * Deletes a field from the session data in the key storage record,
+    *
+    * The `data` field is assumed to be JSON.  Just the field with the given
+    * name is updated and the rest is unchanged.
+    * @param request the Fastifdy request
+    * @param name the field within `data` to update
+    */
+    abstract deleteSessionData(request: FastifyRequest, name: string): Promise<void>;
+    /**
+     * Return data stored in the session with key `name` or undefined if not present
+     * @param request the Fastify request
+     * @param name name of the data to fetch
+     * @return an object of the data, or undefined
+     */
+    abstract getSessionData(request: FastifyRequest, name: string): Promise<{
+        [key: string]: any;
+    } | undefined>;
+}

package/dist/fastifyuserclientendpoints.d.ts

@@ -0,0 +1,61 @@
+import { FastifySessionServer, FastifySessionServerOptions } from './fastifysession';
+
+/**
+ * This class provides user endpoints for the Fastify server for manipulating
+ * OAuth clients.
+ *
+ * Endpoints include changeing password, editing the User record, etc.
+ *
+ * This class is not intended to be created directly.  It is created
+ * by {@link FastifySessionServer}.  For a description of the endpoints,
+ * and how to create templates for them, see that class.
+ */
+export declare class FastifyUserClientEndpoints {
+    private sessionServer;
+    private clientStorage;
+    private clientManager;
+    private prefix;
+    private clientSearchFn;
+    private validFlows;
+    private selectClientPage;
+    private createClientPage;
+    private updateClientPage;
+    private deleteClientPage;
+    /**
+     * Constructor
+     * @param sessionServer instance of the Fatify session server this is being added to
+     * @param options See {@link FastifySessionServerOptions}
+     */
+    constructor(sessionServer: FastifySessionServer, options?: FastifySessionServerOptions);
+    /**
+     * Adds the `selectclient` GET endpoint.
+     */
+    addSelectClientEndpoints(): void;
+    /**
+     * Adds the `createclient` GET and POST endpoints.
+     */
+    addCreateClientEndpoints(): void;
+    /**
+     * Adds the `api/createclient` POST endpointss.
+     */
+    addApiCreateClientEndpoints(): void;
+    /**
+     * Adds the `updateclient` GET and POST endpoints.
+     */
+    addUpdateClientEndpoints(): void;
+    /**
+     * Adds the `api/updateclient` POST endpoints.
+     */
+    addApiUpdateClientEndpoints(): void;
+    /**
+     * Adds the `deleteclient` GET and POST endpoints.
+     */
+    addDeleteClientEndpoints(): void;
+    /**
+     * Adds the `api/deleteclient` POST endpoint.
+     */
+    addApiDeleteClientEndpoints(): void;
+    private createClient;
+    private updateClient;
+    private deleteClient;
+}

package/dist/fastifyuserendpoints.d.ts

@@ -0,0 +1,193 @@
+import { FastifySessionServer, FastifySessionServerOptions, CsrfBodyType } from './fastifysession';
+
+/**
+ * Type for Fastify request body when making an updateuser request.
+ * Allows any key value since developers can add fields to the User object.
+ */
+export interface UpdateUserBodyType extends CsrfBodyType {
+    [key: string]: string | undefined;
+}
+/**
+ * Query parameters for the changefactor2 GET endpoint
+ */
+export interface ChangeFactor2QueryType {
+    next?: string;
+    required?: boolean;
+}
+/**
+ * Body parameters for the changefactor2 POST endpoint
+ */
+export interface ChangeFactor2BodyType extends CsrfBodyType {
+    factor2: string;
+    next?: string;
+    required?: boolean;
+}
+/**
+ * Query parameters for the changepassword GET endpoint
+ */
+export interface ChangePasswordQueryType {
+    next?: string;
+    required?: boolean;
+}
+/**
+ * Body parameters for the changepassword POST endpoint
+ */
+export interface ChangePasswordBodyType extends CsrfBodyType {
+    oldPassword: string;
+    newPassword: string;
+    repeatPassword?: string;
+    next?: string;
+    required?: boolean;
+}
+/**
+ * Query parameters for the configurefactor2 GET endpoingt
+ */
+export interface ConfigureFactor2QueryType {
+    next?: string;
+}
+/**
+ * Body parameters for the configurefactor2 POST endpoint
+ */
+export interface ConfigureFactor2BodyType extends CsrfBodyType {
+    next?: string;
+    otp?: string;
+    token?: string;
+    [key: string]: any;
+}
+/**
+ * Query parameters for the requestpasswordreset GET endpoint
+ */
+export interface RequestPasswordResetQueryType {
+    next?: string;
+    required?: boolean;
+}
+/**
+ * Body parameters for the requestpasswordreset POST endpoint
+ */
+export interface RequestPasswordResetBodyType extends CsrfBodyType {
+    email: string;
+    next?: string;
+    required?: boolean;
+}
+/**
+ * Body parameters for the resetpassword POST endpoint
+ */
+export interface ResetPasswordBodyType extends CsrfBodyType {
+    token: string;
+    newPassword: string;
+    repeatPassword?: string;
+}
+/**
+ * URL parameter for the verifytoken endpoint
+ */
+export interface VerifyTokenParamType {
+    token: string;
+}
+/**
+ * This class provides user endpoints for the Fastify server.
+ *
+ * Endpoints include changeing password, editing the User record, etc.
+ *
+ * This class is not intended to be created directly.  It is created
+ * by {@link FastifySessionServer}.  For a description of the endpoints,
+ * and how to create templates for them, see that class.
+ */
+export declare class FastifyUserEndpoints {
+    private sessionServer;
+    private enableEmailVerification;
+    private enablePasswordReset;
+    /**
+     * The app prefix that was set during construction,
+     */
+    readonly prefix: string;
+    private updateUserPage;
+    private changeFactor2Page;
+    private configureFactor2Page;
+    private changePasswordPage;
+    private resetPasswordPage;
+    private requestPasswordResetPage;
+    private emailVerifiedPage;
+    private signupPage;
+    private deleteUserPage;
+    /**
+     * Constructor.
+     *
+     * @param sessionServer the instance of the Fastify session server this
+     *        object belongs to
+     * @param options See {@link FastifySessionServerOptions}
+     */
+    constructor(sessionServer: FastifySessionServer, options?: FastifySessionServerOptions);
+    /**
+     * Adds the `updateuser` GET and POST endpoints.
+     */
+    addUpdateUserEndpoints(): void;
+    /**
+     * Adds the `api/updateuser` POST endpoint.
+     */
+    addApiUpdateUserEndpoints(): void;
+    /**
+     * Adds the `changefactor2` GET and POST endpoints.
+     */
+    addChangeFactor2Endpoints(): void;
+    /**
+     * Adds the `api/changefactort2` POST endpoint.
+     */
+    addApiChangeFactor2Endpoints(): void;
+    /**
+     * Adds the `changepassword` GET and POST endpoints.
+     */
+    addChangePasswordEndpoints(): void;
+    /**
+     * Adds the `api/changepassword` POST endpoint.
+     */
+    addApiChangePasswordEndpoints(): void;
+    /**
+     * Adds the `configurefactor2` GET and POST endpoints.
+     */
+    addConfigureFactor2Endpoints(): void;
+    /**
+     * Adds the `api/configurefactor2` POST endpoint.
+     */
+    addApiConfigureFactor2Endpoints(prefix: string): void;
+    /**
+     * Adds the `requestpasswordreset` GET and POST endpoints.
+     */
+    addRequestPasswordResetEndpoints(): void;
+    /**
+     * Adds the `api/requestpasswordreset`POST endpoint.
+     */
+    addApiRequestPasswordResetEndpoints(): void;
+    /**
+     * Adds the `resetpassword` GET and POST endpoints.
+     */
+    addResetPasswordEndpoints(): void;
+    /**
+     * Adds the `api/resetpassword` POST endpoint.
+     */
+    addApiResetPasswordEndpoints(): void;
+    /**
+     * Adds the `verifyemail` GET and POST endpoints.
+     */
+    addVerifyEmailEndpoints(): void;
+    /**
+     * Adds the `api/verifyemail` POST endpoint.
+     */
+    addApiVerifyEmailEndpoints(): void;
+    /**
+     * Adds the `deleteuser` GET and POST endpoints.
+     */
+    addDeleteUserEndpoints(): void;
+    /**
+     * Adds the `api/deleteuser` POST endpoint.
+     */
+    addApiDeleteUserEndpoints(): void;
+    private updateUser;
+    private changeFactor2;
+    private changePassword;
+    private configureFactor2;
+    private reconfigureFactor2;
+    private requestPasswordReset;
+    private resetPassword;
+    private verifyEmail;
+    private deleteUser;
+}