Prisma

This document shows how to configure Prisma in a FoalTS project. It assumes that you have already uninstalled TypeORM.

Warning on Configuration

Prisma uses the dotenv library under the hood which handles .env files and environment variables differently.

Therefore, when using Prisma, you can only use one single .env file. Using other files such as .env.local or .env.production will lead to unexpected variable values.

Basic Set Up

This example uses an SQLite database.

Install the latest version of TypeScript (Prisma v2.21 requires at least v4.1).

npm install typescript@latest

If you get compile-time errors referencing the file node_modules/.prisma/client/index.d.ts, it is likely that your version of TypeScript is too old.

Install the Prisma dependencies.

npm install prisma --save-dev
npm install @prisma/client

Init the project.

npx prisma init

Set up the database configuration in prisma/schema.prisma.

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

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

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
}

Specify the database URL in the .env file.

DATABASE_URL="file:./db.sqlite3"

Generate and run the migration.

npx prisma migrate dev --name init

Generate the TypeScript interfaces.

npx prisma generate

Update your src/app/db.ts to create the prisma connection:

import { PrismaClient } from '@prisma/client';

export const prisma = new PrismaClient();

Then update your src/index.ts to inject it into the service manager.

src/index.ts

// 3p
import { ServiceManager } from '@foal/core';
import { PrismaClient } from '@prisma/client';

// App
import { AppController } from './app/app.controller';
import { prisma } from './db';

async function main() {
  const serviceManager = new ServiceManager()
    .set(PrismaClient, prisma);
  const app = await createApp(AppController, { serviceManager });

  // ...
}

main()
  .catch(err => { console.error(err.stack); process.exit(1); })
  .finally(() => { prisma.$disconnect().catch(err => console.error(err)) });

Finally, inject the prisma client into your controllers and start using it.

app.controller.ts

import { dependency, Get, HttpResponseOK, IAppController } from '@foal/core';
import { PrismaClient } from '@prisma/client';

export class AppController implements IAppController {
  @dependency
  prisma: PrismaClient;

  @Get('/users')
  async getAllUsers() {
    const allUsers = await this.prisma.user.findMany();
    return new HttpResponseOK(allUsers);
  }
}

Authenticating users

First, make sure your have a User model defined in schema.prisma.

// ...

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
}

If you haven't already done so, generate and run the migration and generate the TypeScript interfaces.

npx prisma migrate dev --name add-user
npx prisma generate

Then add the user option to your authentication hooks as follows:

@JWTRequired({
  user: (id: number, services: ServiceManager) => services.get(PrismaClient).user.findFirst({
    where: { id }
  })
})
// OR
@UseSessions({
  user: (id: number, services: ServiceManager) => services.get(PrismaClient).user.findFirst({
    where: { id }
  })
})