@dzangolab/fastify-user

A Fastify plugin that provides an easy integration of user model (service, controller, resolver) in a fastify API.

Requirements

• @dzangolab/fastify-config
• @dzangolab/fastify-mailer
• @dzangolab/fastify-slonik
• slonik
• supertokens-node

Installation

Install with npm:

1npm install @dzangolab/fastify-config @dzangolab/fastify-mailer @dzangolab/fastify-slonik @dzangolab/fastify-user slonik supertokens-node

Install with pnpm:

1pnpm add --filter "@scope/project" @dzangolab/fastify-config @dzangolab/fastify-mailer @dzangolab/fastify-slonik @dzangolab/fastify-user slonik supertokens-node

Usage

Register the user plugin with your Fastify instance:

1import configPlugin from "@dzangolab/fastify-config";
2import mailerPlugin from "@dzangolab/fastify-mailer";
3import slonikPlugin, { migrationPlugin } from "@dzangolab/fastify-slonik";
4import userPlugin from "@dzangolab/fastify-user";
5import Fastify from "fastify";
6
7import config from "./config";
8
9import type { ApiConfig } from "@dzangolab/fastify-config";
10import type { FastifyInstance } from "fastify";
11
12const start = async () => {
13  // Create fastify instance
14  const fastify = Fastify({
15    logger: config.logger,
16  });
17
18  // Register fastify-config plugin
19  await fastify.register(configPlugin, { config });
20
21  // Register database plugin
22  await fastify.register(slonikPlugin, config.slonik);
23
24  // Register mailer plugin
25  await fastify.register(mailerPlugin, config.mailer);
26  
27  // Register fastify-user plugin
28  await fastify.register(userPlugin);
29
30  // Run app database migrations
31  await fastify.register(migrationPlugin, config.slonik);
32  
33  await fastify.listen({
34    port: config.port,
35    host: "0.0.0.0",
36  });
37};
38
39start();

Configuration

To add custom email and password validations:

1const config: ApiConfig = {
2  // ...
3  user: {
4    //...
5    email: {
6      host_whitelist: ["..."]
7    },
8    password: {
9      minLength: 8,
10      minLowercase: 1,
11      minUppercase: 0,
12      minNumbers: 1,
13      minSymbols: 0,
14    }
15  }
16};

To overwrite ThirdPartyEmailPassword recipes from config:

1const config: ApiConfig = {
2  // ...
3  user: {
4    //...
5    recipes: {
6      thirdPartyEmailPassword: {
7        override: {
8          apis: {
9            appleRedirectHandlerPOST,
10            authorisationUrlGET,
11            emailPasswordEmailExistsGET,
12            emailPasswordSignInPOST,
13            emailPasswordSignUpPOST,
14            generatePasswordResetTokenPOST,
15            passwordResetPOST,
16            thirdPartySignInUpPOST,
17          },
18          functions: {
19            createResetPasswordToken,
20            emailPasswordSignIn,
21            emailPasswordSignUp,
22            getUserById,
23            getUserByThirdPartyInfo,
24            getUsersByEmail,
25            resetPasswordUsingToken,
26            thirdPartySignInUp,
27            updateEmailOrPassword,
28          },
29        sendEmail,
30        signUpFeature: {
31          formFields: [
32            {
33              id: "password",
34              validate: async (password) => {
35                // if password invalid return invalid message
36              },
37            },
38            //...
39          ],
40        },
41      },
42    },
43  },
44};

NOTE: Each above overridden elements is a wrapper function. For example to override emailPasswordSignUpPOST see emailPasswordSignUpPOST.

Using GraphQL

This package supports integration with @dzangolab/fastify-graphql. Additionally, you will need to install mercurius-auth for authentication.

Configuration

Add the required context for the fastify-user package by including userPlugin in your GraphQL configuration as shown below:

1import userPlugin from "@dzangolab/fastify-user";
2import type { ApiConfig } from "@dzangolab/fastify-config";
3
4const config: ApiConfig = {
5  // ...other configurations...
6  graphql: {
7    // ...other graphql configurations...
8    plugins: [userPlugin],
9  },
10  // ...other configurations...
11};

Schema Integration

The GraphQL schema provided by this package is located at src/graphql/schema.ts and is exported as userSchema.

To load and merge this schema with your application's custom schemas, update your schema file as follows:

1import { userSchema } from "@dzangolab/fastify-user";
2import { loadFilesSync } from "@graphql-tools/load-files";
3import { mergeTypeDefs } from "@graphql-tools/merge";
4import { makeExecutableSchema } from "@graphql-tools/schema";
5
6const schemas: string[] = loadFilesSync("./src/**/*.gql");
7
8const typeDefs = mergeTypeDefs([userSchema, ...schemas]);
9const schema = makeExecutableSchema({ typeDefs });
10
11export default schema;

Resolver Integration

To integrate the resolvers provided by this package, import them and merge with your application's resolvers:

1import { usersResolver } from "@dzangolab/fastify-user";
2
3import type { IResolvers } from "mercurius";
4
5const resolvers: IResolvers = {
6  Mutation: {
7    ...usersResolver.Mutation,
8  },
9  Query: {
10    ...userResolver.Query,
11  },
12};
13
14export default resolvers;