@tsdiapi/prisma: Prisma Integration Plugin for TSDIAPI-Server

@tsdiapi/prisma seamlessly integrates Prisma with TSDIAPI-Server, providing hooks, events, and lifecycle management to enhance database operations.

---

Features

• Prisma Client Integration: Automatically sets up and manages Prisma Client.
• Event System: Listen to events before and after Prisma operations.
• Hook Support: Dynamically modify queries using hooks.
• Lifecycle Management: Handles Prisma Client initialization and cleanup during app lifecycle.
• Configurable Options: Define query timeouts and load custom Prisma-related files via glob patterns.

---

Installation

1npm install @tsdiapi/prisma

Or use the CLI to add the plugin:

1tsdiapi plugins add prisma

📌 Code Generation

The TSDIAPI-Prisma plugin includes code generators to streamline the creation of Prisma event listeners and hooks. Use the tsdiapi CLI to generate these files automatically.

Name	Description
event	Generates a Prisma event listener for a specific model and operation.
hook	Generates a Prisma hook to modify query arguments before execution.

📌 Generate a Prisma Event Listener

This generator creates an event listener that triggers before and after a specified Prisma operation. It will prompt for:

• Model Name (e.g., User, Post)
• Prisma Operation (e.g., FindUnique, Create, Update)

Run the command:

1tsdiapi generate prisma event

---

📌 Generate a Prisma Hook

This generator creates a Prisma hook that allows modification of query arguments before execution. It will prompt for:

• Model Name (e.g., User, Order)
• Prisma Operation (e.g., Create, Update, FindMany)

Run the command:

1tsdiapi generate prisma hook

✅ Easily generate Prisma event listeners and hooks with just one command!

---

Usage

Register the Plugin

Add the plugin to your TSDIAPI-Server setup:

1import { createApp } from "@tsdiapi/server";
2import prismaPlugin from "@tsdiapi/prisma";
3
4createApp({
5  plugins: [
6    prismaPlugin({
7      prismaOptions: {
8        transactionOptions: { timeout: 15000 },
9      },
10    }),
11  ],
12});

Access Prisma Client

The Prisma client is available via the client export:

1import { client } from "@tsdiapi/prisma";
2
3const users = await client.user.findMany();
4console.log(users);

---

Event Handling

Define Prisma Event Listeners

Use decorators to respond to specific database events:

1import { DbAfterListener, PrismaOperation } from "@tsdiapi/prisma";
2import { Service } from "typedi";
3
4@Service()
5export class CustomEvents {
6  @DbAfterListener("User", PrismaOperation.Create)
7  public afterUserCreate(result: { args: any; result: any }) {
8    console.log(`User created with ID: ${result.result.id}`);
9  }
10}

Available decorators:

• DbBeforeListener(model, operation): Triggered before a Prisma query.
• DbAfterListener(model, operation): Triggered after a query is executed.

---

Hook System

Modify queries dynamically using hooks:

1import { Operation, PrismaOperation } from "@tsdiapi/prisma";
2import { Service } from "typedi";
3
4@Service()
5export class QueryHooks {
6  @Operation(PrismaOperation.Create, "User")
7  public modifyUserCreate(args: { data: any }) {
8    args.data.name = `Modified-${args.data.name}`;
9    return args; // Return the modified query arguments
10  }
11}

---

Configuration Options

Option	Type	Default Value	Description
prismaOptions	object	{}	Options for Prisma Client (e.g., timeouts).
autoloadGlobPath	string	"*.prisma{.ts,.js}"	Glob pattern for custom Prisma files.

---

Lifecycle Integration

• onInit: Initializes the Prisma client and sets up hooks/events.
• Cleanup: Ensures the Prisma client disconnects on shutdown (SIGINT, SIGTERM, exit).

---

Example Use Case

Create a simple setup to modify and log Prisma queries:

1import { createApp } from "@tsdiapi/server";
2import prismaPlugin from "@tsdiapi/prisma";
3
4createApp({
5  plugins: [prismaPlugin()],
6});

Define hooks and listeners to customize database interactions:

1@Service()
2export class UserEvents {
3  @Operation(PrismaOperation.Create, "User")
4  public logUserCreation(args: { data: any }) {
5    console.log("Creating user:", args.data);
6  }
7
8  @DbAfterListener("User", PrismaOperation.Create)
9  public afterUserCreated(result: { result: any }) {
10    console.log(`User created successfully: ${result.result.id}`);
11  }
12}

---

Summary

The @tsdiapi/prisma plugin streamlines Prisma integration by providing hooks, events, and lifecycle management. With this plugin, you can easily customize and extend database operations in a clean and modular way.

For more details, refer to the documentation.