Plugins

Modular Architecture, Unlimited Possibilities

Plugins are self-contained modules that seamlessly integrate with the Baasix core.

Unlike simple extensions, plugins are full-featured modules that can add database schemas, register API routes, intercept operations with hooks, provide reusable services, run scheduled tasks, and inject middleware. Everything is automatically discovered and initialized — just import and register. Build it once, share via npm, and use across all your projects.

• Add schemas: create new database collections/tables
• Add routes: register custom API endpoints with full control
• Add hooks: run code before/after CRUD operations
• Add services: provide reusable business logic
• Add schedules: run tasks on a cron schedule
• Add middleware: inject Express middleware for custom processing
• Full TypeScript support with typed context and services
• Publish to npm and share across projects

Define Once, Use Everywhere

Creating a plugin is straightforward. Define your functionality, export it, and register with your server.

import { definePlugin } from '@tspvivek/baasix';

export function myPlugin(config: MyPluginConfig) {
  return definePlugin({
    meta: {
      name: 'my-plugin',
      version: '1.0.0',
      type: 'feature',
      description: 'My awesome plugin',
    },
    schemas: [...],    // Database schemas
    routes: [...],     // API routes
    hooks: [...],      // Lifecycle hooks
    services: [...],   // Business logic
    schedules: [...],  // Cron jobs
    onInit: async (ctx) => { /* setup */ },
    onReady: async (ctx) => { /* ready */ },
  });
}

Plugins vs Extensions

Know when to use which approach for your custom logic.

Plugin Types

Full Access to Baasix Services

Plugins receive a rich context with access to all Baasix services.

Your plugin code gets typed access to the database, authentication, file storage, notifications, cache, and all other Baasix services. No manual dependency injection required.

// Plugin route with full service access
const routes = [{
  path: '/my-plugin/process',
  method: 'POST',
  requireAuth: true,
  handler: async (req, res, context) => {
    const { ItemsService, mailService, getCacheService } = context;
    
    // Use ItemsService with user's permissions
    const items = new ItemsService('orders', {
      accountability: req.accountability,
    });
    
    const order = await items.create({ status: 'pending' });
    
    // Send notification
    await mailService.send({
      to: req.user.email,
      template: 'order-confirmation',
      data: { order },
    });
    
    res.json({ success: true, order });
  },
}];

What You Can Build

Plugins enable powerful, reusable functionality across projects.

Plugins FAQ