Bravellian/Bravellian.Platform.Modularityv2026.2.3.1131
.NET 10.0
Engine-first module infrastructure for generic hosts and adapters.
Get Started
$ dotnet add package Bravellian.Platform.ModularityReadme
Bravellian.Platform.Modularity
Engine-first module infrastructure for transport-agnostic UI, webhook, and background workflows.
Install
dotnet add package Bravellian.Platform.Modularity
Usage
ModuleRegistry.RegisterModule<MyModule>();
builder.Services.AddModuleServices(builder.Configuration);
builder.Services.AddSingleton<UiEngineAdapter>();
builder.Services.AddBravellianWebhooks();
builder.Services.AddModuleWebhookProviders(options =>
{
// Add one or more authenticators; all must succeed.
options.AddModuleWebhookAuthenticator(ctx => new SignatureAuthenticator());
options.AddModuleWebhookAuthenticator(ctx => new ActiveCustomerAuthenticator(ctx.Services));
});
builder.Services.AddSingleton<IRequiredServiceValidator, MyRequiredServiceValidator>();
Examples
Module with UI engine
public sealed class MyModule : IModuleDefinition
{
public string Key => "my-module";
public string DisplayName => "My Module";
public IEnumerable<string> GetRequiredConfigurationKeys() => Array.Empty<string>();
public IEnumerable<string> GetOptionalConfigurationKeys() => Array.Empty<string>();
public void LoadConfiguration(IReadOnlyDictionary<string, string> required, IReadOnlyDictionary<string, string> optional)
{
}
public void AddModuleServices(IServiceCollection services)
{
services.AddSingleton<MyUiEngine>();
}
public void RegisterHealthChecks(ModuleHealthCheckBuilder builder)
{
builder.AddCheck("my-module", () => HealthCheckResult.Healthy());
}
public IEnumerable<IModuleEngineDescriptor> DescribeEngines()
{
yield return new ModuleEngineDescriptor<IUiEngine<MyCommand, MyViewModel>>(
Key,
new ModuleEngineManifest(
"ui.example",
"1.0",
"Example UI engine",
EngineKind.Ui,
Inputs: new[] { new ModuleEngineSchema("command", typeof(MyCommand)) },
Outputs: new[] { new ModuleEngineSchema("viewModel", typeof(MyViewModel)) }),
sp => sp.GetRequiredService<MyUiEngine>());
}
}
Background-only module
public sealed class WorkerModule : IModuleDefinition
{
public string Key => "worker";
public string DisplayName => "Worker";
public IEnumerable<string> GetRequiredConfigurationKeys() => Array.Empty<string>();
public IEnumerable<string> GetOptionalConfigurationKeys() => Array.Empty<string>();
public void LoadConfiguration(IReadOnlyDictionary<string, string> required, IReadOnlyDictionary<string, string> optional)
{
}
public void AddModuleServices(IServiceCollection services)
{
services.AddHostedService<WorkerService>();
}
public void RegisterHealthChecks(ModuleHealthCheckBuilder builder)
{
builder.AddCheck("worker", () => HealthCheckResult.Healthy());
}
public IEnumerable<IModuleEngineDescriptor> DescribeEngines()
=> Array.Empty<IModuleEngineDescriptor>();
}