express-prisma-auth v2.0.2

express-prisma-auth

express-prisma-auth is an authentication library for Node.js applications using Express and Prisma ORM. It provides an out-of-the-box solution for handling user authentication with JWT.

Installation

Install the package via npm:

npm install express-prisma-auth

Requirements

• Node.js
• Prisma ORM
• Express.js
• A PostgreSQL database (or any database supported by Prisma)

Methods

AuthLibrary

The main class to set up and use the authentication library.

Constructor

constructor(prisma: PrismaClient, options: AuthLibraryOptions)

• prisma: An instance of the PrismaClient.
• options: Configuration options for the authentication library.

Options

The AuthLibrary constructor accepts an AuthLibraryOptions object with the following properties:

• jwtSecret (string, required): Secret key for signing JWT tokens. This is used to encrypt and decrypt the JWT tokens. Ensure this key is kept secure.
• refreshSecret (string, required): Secret key for regenerating JWT tokens. Ensure this key is kept secure.

Example User Schema

Define the User model in your Prisma schema:

generator client {
  provider = "prisma-client-js"
}

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

model User {
  id        Int    @id @default(autoincrement()) // required
  email     String @unique // required
  password  String // required
  firstName String
  lastName  String
  ...

  @@map("users") // make sure the table is defined as "users"
}

Usage

Here is a simple example of how to use express-prisma-auth in an Express application:

Prisma Client Initialization

Ensure you have initialized Prisma in your project and have a valid prisma.schema file as shown above. Run the following command to apply migrations:

npx prisma migrate dev --name init

Example Express App

import { PrismaClient } from "@prisma/client";
import express, { Application, Request, Response } from "express";
import { AuthLibrary } from "express-prisma-auth";
import dotenv from "dotenv";

dotenv.config();

const app: Application = express();

app.use(express.json());

const prismaClient = new PrismaClient();
const authLibrary = new AuthLibrary(prismaClient, {
  jwtSecret: process.env.JWT_SECRET as string,
  refreshSecret: process.env.REFRESH_SECRET as string,
});

// Use the authentication routes
app.use("/api/auth", authLibrary.getAuthRoutes());

// Protect your routes using the authentication middleware
app.get(
  "/api/protected",
  authLibrary.getAuthMiddleware(),
  (req: Request, res: Response) => {
    res.send("Hello, authenticated user!");
  }
);

app.listen(5001, () => {
  console.log("App listening on port 5001");
});

export default app;

Available Routes

The AuthLibrary provides the following routes by default:

POST /signup

• Description: Creates a new user.
• Request Body:
  • email (string, required): The user’s email.
  • password (string, required): The user’s password.
  • Other optional fields as defined in your Prisma schema (e.g., firstName, lastName).
• Response Body:
  • success (boolean): Indicates whether the request was successful.
  • message (string): The response message

POST /login

• Description: Authenticates an existing user.
• Request Body:
  • email (string, required): The user’s email.
  • password (string, required): The user’s password.
• Response Body:
  • success (boolean): Indicates whether the request was successful.
  • data (object): Contains the response data.
    • token (string): Access token to be used for authenticated requests.
    • refreshToken (string): The refresh token to be used for obtaining a new access token.

POST /refresh-token

• Description: Refreshes the access token using a refresh token.
• Request Body:
  • refreshToken (string, required): The refresh token.
• Response Body:
  • success (boolean): Indicates whether the request was successful.
  • data (object): Contains the response data.
    • token (string): New access token to be used for authenticated requests.