@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

npm install @tsdiapi/dboptions

Or use the CLI to add the plugin:

tsdiapi plugins add dboptions

Usage

Register the Plugin

Add the plugin to your TSDIAPI-Server setup:

import { createApp } from "@tsdiapi/server";
import DboptionsPlugin from "@tsdiapi/dboptions";
import TsdiapiPrismaPlugin from "@tsdiapi/prisma";
import { isJWTValid } from "@tsdiapi/jwt-auth";
import { AppSchema } from "./dboptions.config";

createApp({
  plugins: [
    DboptionsPlugin({
      tSchema: AppSchema, // TypeBox schema for TSchema transformations
      adminGuard: async (req) => {
        const session = await isJWTValid<any>(req);
        if (!session) {
          return false;
        }
        return session.isAdmin; // Allow only admins
      },
    }),
    TsdiapiPrismaPlugin(),
  ],
});

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:

{
  "DBOPTIONS_AUTO_REGISTER_CONTROLLERS": false
}

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

tsdiapi 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. 🚀