Muonroi.Tenancy.Abstractions 1.0.0-alpha.16

Muonroi.Tenancy.Abstractions

Contracts-only package that defines the multi-tenancy interfaces, options, and models shared across every Muonroi service.

This package ships the contracts (ITenantContext, ITenantIdResolver, ITenantConnectionStringFactory, ITenantScoped) and configuration types (MultiTenantOptions, TenantConnectionStringsOptions) that the rest of the Muonroi tenancy stack depends on. It contains no runtime behavior — register it as a reference in libraries that need the interfaces; use Muonroi.Tenancy.Core for the concrete implementations and Muonroi.Tenancy for ASP.NET middleware.

Installation

dotnet add package Muonroi.Tenancy.Abstractions --prerelease

Quick Start

Because this is a contracts package, the typical usage is either consuming an injected ITenantContext inside a service, or implementing one of the interfaces in your own class.

Consuming the injected context

// In a controller or service — ITenantContext is registered by Muonroi.Tenancy.Core
public class OrderService(ITenantContext tenantContext)
{
    public Task<IEnumerable<Order>> GetOrdersAsync()
    {
        string? tenantId = tenantContext.TenantId;
        // use tenantId to scope the query
    }
}

Implementing a custom tenant-ID resolver

using Muonroi.Tenancy.Abstractions.Interfaces;

public class JwtTenantIdResolver : ITenantIdResolver
{
    public Task<string?> ResolveTenantIdAsync(HttpContext context)
    {
        string? tenantId = context.User.FindFirst("tid")?.Value;
        return Task.FromResult(tenantId);
    }
}

// Registration (in your host project that references Muonroi.Tenancy.Core):
builder.Services.AddScoped<ITenantIdResolver, JwtTenantIdResolver>();

Registering options from configuration

builder.Services.Configure<MultiTenantOptions>(
    builder.Configuration.GetSection(MultiTenantOptions.SectionName)); // "MultiTenantConfigs"

builder.Services.Configure<TenantConnectionStringsOptions>(
    builder.Configuration.GetSection(TenantConnectionStringsOptions.SectionName)); // "TenantConnectionStrings"

// appsettings.json
{
  "MultiTenantConfigs": {
    "Enabled": true,
    "RequireTenantClaimForAuthenticatedUser": true,
    "Strategy": "SharedSchema",
    "EnableRowLevelSecurity": false
  },
  "TenantConnectionStrings": {
    "ConnectionStrings": {
      "acme": "Host=db-acme;Database=acme;Username=app;Password=secret",
      "beta": "Host=db-beta;Database=beta;Username=app;Password=secret"
    }
  }
}

For a complete working example — including TenantContext, DefaultTenantIdResolver, TenantSchemaSelector, MappingTenantConnectionStringFactory, and TenantResolutionMiddleware — see the Quickstart.Tenancy sample.

Features

• ITenantContext — get/set the ambient TenantId for the current execution scope.
• ITenantIdResolver — extract a tenant ID from an HttpContext asynchronously.
• ITenantConnectionStringFactory — resolve a connection string by tenant ID.
• ITenantScoped — marker interface for domain entities and services that belong to a single tenant.
• MultiTenantOptions — enable/disable multi-tenancy, pick isolation strategy (SharedSchema, SeparateSchema, SeparateDatabase), and opt in to PostgreSQL Row-Level Security.
• TenantConnectionStringsOptions — map tenant IDs to connection strings via appsettings.json.
• TenantIsolationStrategy enum — three isolation levels consumed by the runtime layer.
• NoOpTenantContext — null-object ITenantContext for single-tenant or test scenarios.
• ITenantLicenseFeatureGate — check whether a tenant has a named license feature enabled.
• TenantLicenseFeatures.Premium.MultiTenant — well-known feature-name constant for multi-tenancy license gating.
• Legacy contracts (Muonroi.Tenancy.Abstractions.Legacy) — ITenantContext and ITenantIdResolver kept for backward compatibility; prefer the canonical types above for new code.

Configuration

MultiTenantOptions binds from the "MultiTenantConfigs" section:

TenantConnectionStringsOptions binds from the "TenantConnectionStrings" section:

API Reference

Samples

• Quickstart.Tenancy — end-to-end example: registers TenantContext, DefaultTenantIdResolver, MappingTenantConnectionStringFactory, and TenantResolutionMiddleware; exercises each via REST endpoints.

Compatibility

• Target framework: net8.0
• License: Apache-2.0 (OSS)

Related Packages

• Muonroi.Tenancy.Core — concrete implementations: TenantContext (AsyncLocal), DefaultTenantIdResolver, MappingTenantConnectionStringFactory, TenantSchemaSelector.
• Muonroi.Tenancy — ASP.NET integration: TenantResolutionMiddleware and Redis tenant cache.
• Muonroi.Tenancy.SiteProfile — site-profile multi-tenancy: ISiteProfile, AddSiteProfile<T>(), per-site DI isolation.
• Muonroi.Quota.Abstractions — quota contracts depended on by this package.
• Muonroi.Core.Abstractions — base platform contracts.

License

Apache-2.0. See LICENSE-APACHE.