tenant

Tenant Plugin

Multi-tenant domain management plugin for Leeforge CMS. Provides tenant CRUD, membership management, domain resolution, and event-driven lifecycle hooks.

Quick Start

import (
    tenant "github.com/leeforge/plugins/tenant"
    tenantfactory "github.com/leeforge/plugins/tenant/factory"
)

// 1. Register factory (before plugin Enable)
services.Register(tenant.ServiceKeyTenantFactory, tenantfactory.NewEntFactory(entClient))

// 2. Register plugin
runtime.Register(&tenant.TenantPlugin{})

Plugin Metadata

Architecture

tenant/                        # https://github.com/leeforge/plugins/tree/main/tenant
├── plugin.go                  # Plugin lifecycle (Enable/Disable/Install)
├── ports.go                   # ServiceFactory interface
├── shared/
│   ├── errors.go              # Exported error sentinels
│   ├── events.go              # Event constants and payloads
│   ├── exported.go            # Re-exported public types
│   └── ports.go               # RoleSeeder / UserLookup interfaces
├── tenant/
│   ├── handler.go             # HTTP handlers
│   ├── service.go             # Business logic
│   └── dto.go                 # Request/Response DTOs
└── factory/
    └── ent_factory.go         # Default Ent-backed factory

ServiceFactory

Host application must provide a ServiceFactory implementation registered under ServiceKeyTenantFactory:

const ServiceKeyTenantFactory = "adapter.tenant.factory"

type ServiceFactory interface {
    NewTenantService(domainSvc core.DomainWriter, events plugin.EventBus, logger logging.Logger) *tenantmod.Service
    RoleSeeder() RoleSeeder
    UserLookup() UserLookup
    Models() []any
}

The built-in factory.EntFactory provides a default implementation backed by core/server/ent.Client.

HTTP Routes

All routes are registered under /tenants:

Events

Published

Subscribed

Event Payloads

type TenantEventData struct {
    TenantID   uuid.UUID `json:"tenantId"`
    TenantCode string    `json:"tenantCode"`
    DomainID   uuid.UUID `json:"domainId"`
    ActorID    uuid.UUID `json:"actorId"`
}

type MemberEventData struct {
    TenantID uuid.UUID `json:"tenantId"`
    UserID   uuid.UUID `json:"userId"`
    Role     string    `json:"role"`
    ActorID  uuid.UUID `json:"actorId"`
}

Service Keys

Public API (Cross-Plugin)

Other plugins can resolve TenantServiceAPI from the service registry:

type TenantServiceAPI interface {
    GetTenant(ctx context.Context, id uuid.UUID) (*TenantInfo, error)
    GetTenantByCode(ctx context.Context, code string) (*TenantInfo, error)
    IsMember(ctx context.Context, tenantID, userID uuid.UUID) (bool, error)
    GetDomainID(ctx context.Context, tenantCode string) (uuid.UUID, error)
}

Domain Resolution

The tenant plugin implements the domain plugin pattern:

• ResolveDomain() — Resolves tenant domain from X-Tenant-ID header
• ValidateMembership() — Checks if subject is member of domain
• TypeCode() — Returns "tenant"

Error Sentinels

import "github.com/leeforge/plugins/tenant/shared"

shared.ErrTenantNotFound       // Tenant not found
shared.ErrTenantCodeExists     // Tenant code already exists
shared.ErrInvalidTenant        // Invalid tenant data
shared.ErrMemberExists         // User is already a member
shared.ErrMemberNotFound       // Membership not found
shared.ErrPlatformDomainOnly   // Operation requires platform domain
shared.ErrParentTenantInvalid  // Invalid parent tenant

Framework Interfaces

TenantPlugin implements:

Ent Models

The plugin requires these Ent schemas (provided by core/server/ent):

• Tenant — Tenant entity with code, name, domain reference
• TenantUser — Tenant membership (user-tenant-role mapping)