@tsdiapi/dboptions: Database Options Plugin for TSDIAPI-Server

@tsdiapi/dboptions extends TSDIAPI-Server with dynamic database options, integrating seamlessly with Prisma. It enables storing and managing configuration settings in a database with optional TSchema transformation and authentication control.

---

Features

• Prisma Integration: Automatically adds a DbOption model for storing key-value configurations.
• Dynamic API Routes: Provides endpoints for managing database options.
• TSchema Support: Optionally transform database-stored values using a TSchema.
• JWT Authentication: Secure access using a custom adminGuard function.
• Auto-Registration: Automatically integrates controllers when enabled.
• Feature Generator: Allows custom entity names for full control over the setup.

---

Installation

1npm install @tsdiapi/dboptions

Or use the CLI to add the plugin:

1tsdiapi plugins add dboptions

---

Usage

Register the Plugin

Add the plugin to your TSDIAPI-Server setup:

1import { createApp } from "@tsdiapi/server";
2import DboptionsPlugin from "@tsdiapi/dboptions";
3import TsdiapiPrismaPlugin from "@tsdiapi/prisma";
4import { isJWTValid } from "@tsdiapi/jwt-auth";
5import { AppSchema } from "./dboptions.config";
6
7createApp({
8  plugins: [
9    DboptionsPlugin({
10      tSchema: AppSchema, // TypeBox schema for TSchema transformations
11      adminGuard: async (req) => {
12        const session = await isJWTValid<any>(req);
13        if (!session) {
14          return false;
15        }
16        return session.isAdmin; // Allow only admins
17      },
18    }),
19    TsdiapiPrismaPlugin(),
20  ],
21});

---

Configuration Options

Option	Type	Default	Description
tSchema	TObject	null	TypeBox schema for transformations.
adminGuard	Function	null	Custom function to validate Bearer authentication.

---

Auto-Registration

If DBOPTIONS_AUTO_REGISTER_CONTROLLERS is enabled, the plugin:

• Adds the DbOption model to Prisma schema.
• Automatically registers API controllers for managing options.

To disable auto-registration, use:

1{
2  "DBOPTIONS_AUTO_REGISTER_CONTROLLERS": false
3}

For manual setup, use the feature generator to create a custom entity:

1tsdiapi generate dboptions feature

This allows defining a custom database model and gaining full control over API behavior.

---

Summary

The @tsdiapi/dboptions plugin extends TSDIAPI with a database-driven configuration system. It supports Prisma, TSchema-based transformations, and flexible authentication control. Use auto-registration for quick setup or manual generation for advanced customization. 🚀