Shiny.Mediator.Contracts 1.0.0-alpha-0036

Prefix Reserved
This is a prerelease version of Shiny.Mediator.Contracts.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Shiny.Mediator.Contracts --version 1.0.0-alpha-0036
                    
NuGet\Install-Package Shiny.Mediator.Contracts -Version 1.0.0-alpha-0036
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Shiny.Mediator.Contracts" Version="1.0.0-alpha-0036" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Shiny.Mediator.Contracts" Version="1.0.0-alpha-0036" />
                    
Directory.Packages.props
<PackageReference Include="Shiny.Mediator.Contracts" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Shiny.Mediator.Contracts --version 1.0.0-alpha-0036
                    
#r "nuget: Shiny.Mediator.Contracts, 1.0.0-alpha-0036"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Shiny.Mediator.Contracts@1.0.0-alpha-0036
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Shiny.Mediator.Contracts&version=1.0.0-alpha-0036&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=Shiny.Mediator.Contracts&version=1.0.0-alpha-0036&prerelease
                    
Install as a Cake Tool

Shiny Mediator (Preview)

PLEASE NOTE - THIS IS AN ALPHA. THINGS ARE LIKELY TO CHANGE

<a href="https://www.nuget.org/packages/Shiny.Mediator" target="_blank"> <img src="https://buildstats.info/nuget/Shiny.Mediator?includePreReleases=true" /> </a>

A mediator pattern, but for apps. Apps have pages with lifecycles that don't necessarily participate in the standard dependency injection lifecycle. .NET MAUI generally tends to favor the Messenger pattern. We hate this pattern for many reasons which we won't get into. That being said, we do offer a messenger subscription in our Mediator for where interfaces and dependency injection can't reach.

This project is heavily inspired by MediatR with some lesser features that we feel were aimed more at server scenarios, while also adding some features we feel benefit apps

Features

  • A Mediator for your .NET Apps (MAUI & Blazor are the main targets for us)
  • Think of "weak" message subscriptions without the fuss or mess to cleanup
  • Our MAUI & Blazor integrations allow your viewmodels or pages to implement an IEventHandler<TEvent> interface(s) without them having to participate in the dependency injection provider
  • We still have a "messagingcenter" type subscribe off IMediator for cases where you can't have your current type implement an interface
  • Instead of Assembly Scanning, we have source generators to automatically wireup the necessary registrations for you! (WIP)
  • Lightweight, No external dependencies, tiny bit of reflection
  • Help remove service overrun and reduce your constructor fat
  • Easy to Unit Test

Works With

  • .NET MAUI - all platforms
  • MVVM Frameworks like Prism, ReactiveUI, & .NET MAUI Shell
  • Blazor - Work In Progress
  • Any other .NET platform - but you'll have to come up with your own "event collector" for the out-of-state stuff

Getting Started

Install Shiny.Mediator from NuGet

First, let's create our request & event handlers

using Shiny.Mediator;

public record TestRequest(string AnyArgs, int YouWant) : IRequest;
public record TestEvent(MyObject AnyArgs) : IEvent;

// and for request/response requests - we'll come back to this
public record TestResponseRequest : IRequest<TestResponse> {}
public record TestResponse {}

Next - let's wire up a RequestHandler. You can have ONLY 1 request handler per request type. This is where you would do the main business logic or data requests.

Let's create our RequestHandler

using Shiny.Mediator;

// NOTE: Request handlers are registered as singletons
public class TestRequestHandler : IRequestHandler<TestRequest> 
{
    // you can do all dependency injection here
    public async Task Handle(TestRequest request, CancellationToken ct) 
    {
        // do something async here
    }
}

public class TestResponseRequestHandler : IRequestHandler<TestResponseRequest, TestResponse>
{
    public async Task<TestResponse> Handle(TestResponseRequest request, CancellationToken ct)
    {
        var response = await GetResponseThing(ct);
        return response;
    }
}

public class TestEventHandler : IEventHandler<TestEvent> 
{
    // Dependency injection works here
    public async Task Handle(TestEvent @event, CancellationToken ct)
    {
        // Do something async here
    }
}

Now, let's register all of our stuff with our .NET MAUI MauiProgram.cs

public static class MauiProgram
{
    public static MauiApp CreateMauiApp()
    {
        var builder = MauiApp
            .CreateBuilder()
            .UseMauiApp<App>();
        
        builder.Services.AddShinyMediator();
        builder.Services.AddSingletonAsImplementedInterfaces<TestEventHandler>();
        builder.Services.AddSingletonAsImplementedInterfaces<TestRequestHandler>();
        builder.Services.AddSingltonAsImplementedInterfaces<TestResponseRequestHandler>();
        // OR if you're using our attribute for source generation
    }
}

Lastly, any model model/viewmodel/etc participating in dependency injection can now inject the mediator

public class MyViewModel(Shiny.Mediator.IMediator mediator)
{
    public async Task Execute() 
    {
        await mediator.Send(new TestRequest()); // this will execute TestRequestHandler
        var response = await mediator.Request(new TestResponseRequest()); // this will execute TestResponseRequestHandler and return a value
        
        // this will publish to any service registered that implement IEventHandler<TestEvent>
        // there are additional args here to allow you to execute values in sequentially or wait for all events to complete
        await mediator.Publish(new TestEvent()); 
    }
}

What about my ViewModels?

For .NET MAUI, your viewmodels have the ability to participate in the event publishing chain without being part of dependency injection

With this setup, you don't need to worry about deallocating any events, unsubscribing from some service, or hooking to anything.

Lastly, if your page/viewmodel is navigated away from (popped), it will no longer participate in the event broadcast

First, let's install Shiny.Mediator.Maui Now...let's go back to our MauiProgram.cs and alter the AddShinyMediator

builder.Services.AddShinyMediator(cfg => cfg.UseMaui());

Now your viewmodel (or page) can simply implement the IEventHandler<T> interface to participate

NOTE: Further example to below - you can implement multiple event handlers (or request handlers)

public class MyViewModel : BaseViewModel, 
                           Shiny.Mediator.IEventHandler<TestEvent>,
                           Shiny.Mediator.IEventHandler<TestEvent>
{
    public async Task Handle(TestEvent @event, CancellationToken ct)
    {
    }
    
    public async Task Handle(TestEvent2 @event, CancellationToken ct)
    {
    }
}

Sample

There is a sample in this repo. You do not need any other part of Shiny, Prism, ReactiveUI, etc - those are included as I write things faster with it. Focus on the interfaces from the mediator & the mediator calls itself

Ideas for Workflows Request & Events

  • Use Prism with Modules - want strongly typed navigation parameters, navigations, and have them available to other modules - we're the guy to help!
    • Example TBD
  • Using a Shiny Foreground Job - want to push data an event that new data came in to anyone listening?
  • Have a Shiny Push Delegate that is executing on the delegate but want to push it to the UI, Mediator has a plan!

TODO

  • Document
    • Event Collectors
    • Request Middleware
    • Covariance Event Handlers & Request Middleware - Dependency Injection Support - nothing to do with the library
    • OOBE Middleware - easy, not feature rich - use as a template once you outgrow them
  • Event Collectors for MAUI execute on main thread?
  • Streams - IAsyncEnumerable or IObservable
  • Source Generator Registration
    • Need to use a different method or not use extension methods - maybe AddHandlersFromAssemblyName or allow it to be custom named
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net8.0

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Shiny.Mediator.Contracts:

Package Downloads
Shiny.Mediator

The main Shiny Mediator library where all the infrastructure lives

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
4.10.0-beta-0006 197 8/28/2025
4.10.0-beta-0005 120 8/22/2025
4.10.0-beta-0004 148 8/22/2025
4.10.0-beta-0003 157 8/18/2025
4.10.0-beta-0002 154 8/18/2025
4.10.0-beta-0001 120 7/29/2025
4.9.1 360 7/29/2025
4.9.0 211 7/26/2025
4.9.0-beta-0005 492 7/22/2025
4.9.0-beta-0004 489 7/22/2025
4.9.0-beta-0003 488 7/22/2025
4.9.0-beta-0002 435 7/21/2025
4.9.0-beta-0001 367 7/21/2025
4.8.0 132 7/18/2025
4.8.0-beta-0004 45 7/18/2025
4.8.0-beta-0003 196 7/14/2025
4.8.0-beta-0002 193 7/14/2025
4.8.0-beta-0001 184 7/14/2025
4.7.0 456 6/25/2025
4.7.0-beta-0026 184 7/13/2025
4.7.0-beta-0025 183 7/10/2025
4.7.0-beta-0023 192 6/25/2025
4.7.0-beta-0022 192 6/24/2025
4.7.0-beta-0021 192 6/23/2025
4.7.0-beta-0020 194 6/19/2025
4.7.0-beta-0004 187 6/19/2025
4.6.6 201 6/19/2025
4.6.5 195 6/19/2025
4.6.4 191 6/19/2025
4.6.3 437 6/18/2025
4.6.2 194 6/18/2025
4.6.1 224 6/16/2025
4.6.1-beta-0005 190 6/18/2025
4.6.1-beta-0003 194 6/18/2025
4.6.1-beta-0001 188 6/16/2025
4.6.0 193 6/16/2025
4.5.0 399 6/10/2025
4.5.0-beta-0007 331 6/10/2025
4.5.0-beta-0006 314 6/9/2025
4.5.0-beta-0004 146 6/6/2025
4.5.0-beta-0002 177 6/6/2025
4.4.0 440 6/3/2025
4.4.0-beta-0025 189 6/3/2025
4.4.0-beta-0023 193 5/29/2025
4.4.0-beta-0021 198 5/29/2025
4.4.0-beta-0018 204 5/26/2025
4.4.0-beta-0017 194 5/26/2025
4.4.0-beta-0015 195 5/26/2025
4.4.0-beta-0014 203 5/26/2025
4.4.0-beta-0004 156 5/25/2025
4.2.2 393 5/24/2025
4.2.1 360 5/8/2025
4.2.0 329 4/25/2025
4.2.0-beta-0010 208 5/8/2025
4.2.0-beta-0009 198 5/8/2025
4.2.0-beta-0008 168 4/25/2025
4.2.0-beta-0001 253 4/16/2025
4.1.0 518 3/28/2025
4.1.0-beta-0001 196 3/28/2025
4.0.4 500 3/24/2025
4.0.4-beta-0001 460 3/24/2025
4.0.3 328 3/23/2025
4.0.3-beta-0007 323 3/23/2025
4.0.2 302 3/15/2025
4.0.1 435 3/5/2025
4.0.1-beta-0010 214 3/19/2025
4.0.1-beta-0009 131 3/15/2025
4.0.1-beta-0001 285 3/5/2025
4.0.0 285 3/4/2025
4.0.0-beta-0021 268 3/4/2025
4.0.0-beta-0017 257 3/4/2025
4.0.0-beta-0016 279 3/4/2025
4.0.0-beta-0010 166 3/2/2025
4.0.0-beta-0009 167 3/2/2025
4.0.0-beta-0002 165 3/1/2025
3.3.1 341 2/20/2025
3.3.0 170 2/20/2025
3.3.0-beta-0028 151 2/20/2025
3.3.0-beta-0025 183 2/19/2025
3.3.0-beta-0024 185 2/19/2025
3.3.0-beta-0004 148 2/8/2025
3.2.0 434 1/29/2025
3.2.0-beta-0027 135 1/29/2025
3.2.0-beta-0023 145 1/29/2025
3.2.0-beta-0020 136 1/29/2025
3.1.3 154 1/29/2025
3.1.2 161 1/28/2025
3.1.1 180 1/25/2025
3.1.0 154 1/25/2025
3.1.0-beta-0013 140 1/25/2025
3.1.0-beta-0006 140 1/25/2025
3.1.0-beta-0004 145 1/25/2025
3.0.0 147 1/24/2025
3.0.0-beta-0055 141 1/24/2025
3.0.0-beta-0046 135 1/23/2025
3.0.0-beta-0045 146 1/23/2025
3.0.0-beta-0043 152 1/23/2025
3.0.0-beta-0038 167 1/21/2025
3.0.0-beta-0037 143 1/21/2025
3.0.0-beta-0029 156 1/21/2025
3.0.0-beta-0028 141 1/21/2025
3.0.0-beta-0018 143 1/19/2025
3.0.0-beta-0016 127 1/14/2025
3.0.0-beta-0012 141 1/12/2025
3.0.0-beta-0008 153 1/2/2025
3.0.0-beta-0007 156 12/28/2024
3.0.0-beta-0004 147 12/22/2024
2.2.0-beta-0001 352 10/28/2024
2.1.1 763 10/28/2024
2.1.0 300 10/19/2024
2.1.0-beta-0016 154 10/19/2024
2.1.0-beta-0015 161 10/19/2024
2.1.0-beta-0014 172 10/19/2024
2.1.0-beta-0013 169 10/19/2024
2.1.0-beta-0011 183 10/18/2024
2.1.0-beta-0010 172 10/18/2024
2.1.0-beta-0004 152 10/8/2024
2.1.0-beta-0002 147 10/6/2024
2.0.2 430 10/6/2024
2.0.1 170 10/6/2024
2.0.0 237 10/4/2024
2.0.0-beta-0060 152 10/6/2024
2.0.0-beta-0059 143 10/6/2024
2.0.0-beta-0056 150 10/4/2024
2.0.0-beta-0054 155 10/3/2024
2.0.0-beta-0053 142 10/2/2024
2.0.0-beta-0052 154 10/2/2024
2.0.0-beta-0050 161 10/2/2024
2.0.0-beta-0049 156 10/2/2024
2.0.0-beta-0046 163 10/1/2024
2.0.0-beta-0044 161 9/30/2024
2.0.0-beta-0026 164 9/24/2024
2.0.0-beta-0023 152 9/23/2024
2.0.0-beta-0022 145 9/23/2024
2.0.0-beta-0020 173 9/22/2024
2.0.0-beta-0004 160 9/20/2024
2.0.0-beta-0003 169 9/20/2024
1.9.0-beta-0003 156 9/16/2024
1.9.0-beta-0001 164 9/15/2024
1.9.0-beta 155 9/15/2024
1.8.1 341 9/14/2024
1.8.1-beta-0006 154 9/14/2024
1.8.1-beta-0005 155 9/14/2024
1.8.1-beta-0004 171 9/14/2024
1.8.1-beta-0003 158 9/14/2024
1.8.1-beta-0002 173 9/14/2024
1.8.1-beta-0001 160 9/14/2024
1.8.0 234 9/12/2024
1.8.0-beta-0064 186 9/12/2024
1.8.0-beta-0063 188 9/12/2024
1.8.0-beta-0059 181 9/8/2024
1.8.0-beta-0058 161 9/8/2024
1.8.0-beta-0057 194 9/8/2024
1.8.0-beta-0054 186 9/7/2024
1.8.0-beta-0053 194 9/6/2024
1.8.0-beta-0052 176 9/6/2024
1.8.0-beta-0051 196 9/6/2024
1.8.0-beta-0044 186 9/5/2024
1.8.0-beta-0042 184 9/4/2024
1.8.0-beta-0041 178 9/4/2024
1.8.0-beta-0027 187 8/25/2024
1.8.0-beta-0022 189 8/23/2024
1.8.0-beta-0017 187 8/7/2024
1.8.0-beta-0012 125 7/28/2024
1.8.0-beta-0010 130 7/28/2024
1.7.5 234 8/23/2024
1.7.4 345 8/9/2024
1.7.3 194 8/7/2024
1.7.2 163 7/28/2024
1.7.1 142 7/28/2024
1.7.0 213 7/20/2024
1.7.0-beta-0005 157 7/20/2024
1.7.0-beta-0001 184 7/8/2024
1.6.0 199 7/8/2024
1.6.0-beta-0004 164 7/7/2024
1.5.0 198 7/6/2024
1.5.0-beta-0010 167 7/6/2024
1.5.0-beta-0006 168 7/4/2024
1.4.5 196 7/4/2024
1.4.2 195 6/30/2024
1.4.1 182 6/30/2024
1.4.0 177 6/30/2024
1.4.0-beta-0010 161 6/30/2024
1.3.1 184 6/29/2024
1.3.0 172 6/29/2024
1.3.0-beta-0014 149 6/29/2024
1.3.0-beta-0007 142 6/26/2024
1.2.0 181 6/20/2024
1.2.0-beta-0001 153 6/20/2024
1.1.0 189 6/17/2024
1.1.0-beta-0019 158 6/20/2024
1.1.0-beta-0016 160 6/19/2024
1.1.0-beta-0014 157 6/17/2024
1.1.0-beta-0013 155 6/17/2024
1.0.0 206 6/15/2024
1.0.0-alpha-0054 155 6/15/2024
1.0.0-alpha-0053 156 6/12/2024
1.0.0-alpha-0051 136 6/12/2024
1.0.0-alpha-0048 141 6/10/2024
1.0.0-alpha-0047 140 6/10/2024
1.0.0-alpha-0043 142 6/9/2024
1.0.0-alpha-0042 161 6/7/2024
1.0.0-alpha-0040 141 6/6/2024
1.0.0-alpha-0038 147 6/6/2024
1.0.0-alpha-0036 147 6/5/2024
1.0.0-alpha-0034 163 6/4/2024
1.0.0-alpha-0031 142 6/4/2024
1.0.0-alpha-0025 148 6/3/2024
1.0.0-alpha-0023 145 6/2/2024
1.0.0-alpha-0022 153 6/1/2024
1.0.0-alpha-0019 138 6/1/2024
1.0.0-alpha-0018 146 6/1/2024
1.0.0-alpha-0014 151 6/1/2024
1.0.0-alpha-0013 148 6/1/2024
1.0.0-alpha-0012 165 5/31/2024
1.0.0-alpha-0011 160 5/31/2024
1.0.0-alpha-0010 163 5/31/2024