@tsdiapi/prisma-rest

A TSDIAPI plugin that provides dynamic REST API access to your Prisma models with built-in security controls.

📌 About

This is a TSDIAPI plugin that provides a single dynamic endpoint to access your Prisma models through REST API. It includes built-in security features and access control.

🔗 TSDIAPI CLI: @tsdiapi/cli

---

📦 Installation

You can install this plugin using npm:

1tsdiapi add prisma-rest

Then, register the plugin in your TSDIAPI project:

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

---

🚀 Features

• 🔄 Dynamic Endpoint - Single endpoint for all Prisma operations
• 🔒 JWT Authentication - Built-in JWT guard support
• 🌐 IP Restrictions - Control access based on IP addresses
• 🎯 Method Control - Enable/disable specific Prisma methods
• 🏷️ Model Selection - Choose which models to expose through the API
• 🔍 Request Filtering - Modify or validate request data before processing
• 🎛️ Model-Specific Configuration - Fine-grained control over methods and IPs per model

📱 Prisma REST Client

A TypeScript client for working with Prisma REST API generated by this plugin.

🔗 NPM Package: @tsdiapi/prisma-rest-client
🔗 Demo: https://tsdiapi.com/prisma-rest-client

Client Features

• Full type safety using Prisma types
• Automatic model and method validation
• Support for all Prisma methods (findMany, findUnique, create, update, delete, etc.)
• JWT authentication
• Error handling
• Minified bundle for browser usage

Installation

1npm install prisma @prisma/client @tsdiapi/prisma-rest-client

Usage Example

1// Get the Prisma client (types only)
2import { PrismaClient } from '@prisma/client';
3import { PrismaRestClient } from '@tsdiapi/prisma-rest-client';
4
5// Create client instance with the Prisma client
6const instance = new PrismaRestClient<PrismaClient>({
7    apiUrl: "http://localhost:3100/api/prisma/v1",
8    token: "your-jwt-token"
9});
10
11// Get typed client
12const client = instance.useClient();
13
14// Use like a regular Prisma client
15async function main() {
16    // Get list of users
17    const users = await client.user.findMany({
18        where: {
19            email: {
20                contains: '@example.com'
21            }
22        },
23        select: {
24            id: true,
25            email: true,
26            name: true
27        }
28    });
29
30    // Create new user
31    const newUser = await client.user.create({
32        data: {
33            email: 'user@example.com',
34            name: 'John Doe'
35        }
36    });
37
38    // Update user
39    const updatedUser = await client.user.update({
40        where: { id: 'user-id' },
41        data: { name: 'Jane Doe' }
42    });
43
44    // Delete user
45    await client.user.delete({
46        where: { id: 'user-id' }
47    });
48}
49
50main().catch(console.error);

Security

The client works with the following security mechanisms provided by the plugin:

• Model access restrictions
• Method access restrictions
• IP address restrictions
• JWT authentication

It is recommended to configure these restrictions according to your security requirements.

Development

For development and testing:

1. Clone the repository
2. Install dependencies: npm install
3. Run the build: npm run build
4. For development with auto-rebuild: npm run dev

The repository includes an example HTML page for testing the client. Open https://tsdiapi.com/prisma-rest-client in your browser after building.

---

🔧 Configuration

This plugin can be configured through environment variables or during initialization:

1createPlugin({
2  enabled: true,
3  // Global filter function
4  filter: async (model, method, request, req) => {
5    // Modify or validate request data
6    return request;
7  },
8  // Model-specific configurations
9  access: {
10    User: {
11      allowedMethods: ['findMany', 'findUnique'],
12      allowedIps: ['127.0.0.1'],
13      filter: async (model, method, request, req) => {
14        // Model-specific request filtering
15        return request;
16      }
17    }
18  }
19});

Configuration Options

Variable	Type	Default	Description
PRISMA_REST_ENABLED	boolean	true	Enable/disable the REST API
PRISMA_REST_METHODS	string	"*"	Comma-separated list of allowed Prisma methods
PRISMA_REST_MODELS	string	"*"	Comma-separated list of models to expose
PRISMA_REST_ALLOWED_IPS	string	"127.0.0.1,::1"	Comma-separated list of allowed IP addresses
PRISMA_REST_GUARD	string	"admin"	Guard name for JWT authentication

Advanced Configuration

Request Filtering

You can add a global filter function or model-specific filters to modify or validate request data:

1createPlugin({
2  // Global filter for all models
3  filter: async (model, method, request, req) => {
4    // Add timestamp to all requests
5    return {
6      ...request,
7      timestamp: new Date().toISOString()
8    };
9  },
10  access: {
11    User: {
12      // Model-specific filter
13      filter: async (model, method, request, req) => {
14        // Validate user creation
15        if (method === 'create' && !request.email) {
16          throw new Error('Email is required for user creation');
17        }
18        return request;
19      }
20    }
21  }
22});

Model-Specific Configuration

You can configure allowed methods and IP addresses for specific models:

1createPlugin({
2  access: {
3    User: {
4      allowedMethods: ['findMany', 'findUnique'], // Only allow read operations
5      allowedIps: ['127.0.0.1', '192.168.1.1']   // Restrict access to specific IPs
6    },
7    Post: {
8      allowedMethods: ['create', 'update'],       // Only allow write operations
9      allowedIps: ['*']                           // Allow all IPs
10    }
11  }
12});

Filter Function Parameters

The filter function receives the following parameters:

• model: The Prisma model name
• method: The Prisma method being called
• request: The request body data
• req: The full request object with state

The filter function can:

• Modify the request data
• Validate the request data
• Throw errors to prevent invalid operations
• Access request state and headers

---

📌 How to Use

The plugin provides a single dynamic endpoint:

1POST /api/v1/prisma/:method/:model

Example Usage:

1// Create a new user
2POST /api/v1/prisma/create/user
3{
4  "name": "John Doe",
5  "email": "john@example.com"
6}
7
8// Find users
9POST /api/v1/prisma/findMany/user
10{
11  "where": {
12    "email": "john@example.com"
13  }
14}
15
16// Update user
17POST /api/v1/prisma/update/user
18{
19  "where": {
20    "id": 1
21  },
22  "data": {
23    "name": "John Smith"
24  }
25}

Authentication

All requests require JWT authentication with the specified guard.

Error Responses

• 400: Invalid method, model, or request data
• 403: IP not allowed or authentication failed
• 500: Server error

---

🔗 Related Plugins

You can find more TSDIAPI plugins here:
🔗 Available Plugins

---

👨‍💻 Contributing

Contributions are always welcome! If you have ideas for improving this plugin, feel free to open a pull request.

Author: unbywyd
GitHub Repository: https://github.com/unbywyd/tsdiapi-prisma-rest

📧 Contact: unbywyd@gmail.com

🚀 Happy coding with TSDIAPI! 🎉