Shiny.Mediator.Contracts 1.0.0-alpha-0023

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-0023
                    
NuGet\Install-Package Shiny.Mediator.Contracts -Version 1.0.0-alpha-0023
                    
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-0023" />
                    
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-0023" />
                    
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-0023
                    
#r "nuget: Shiny.Mediator.Contracts, 1.0.0-alpha-0023"
                    
#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-0023
                    
#: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-0023&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=Shiny.Mediator.Contracts&version=1.0.0-alpha-0023&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 - TBD
  • 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.Send(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<MauiEventCollector>();

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

  • 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!

Request Middleware Ideas

  • Connectivity check - pull from cache/memory or go to the API

TODO

  • Explain Event Collectors
  • 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
  • IEventHandler<IEvent> can handle ALL events?
  • Request Middleware - Covariance/catch-all
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
5.0.0-beta-0006 30 10/17/2025
5.0.0-beta-0005 105 10/17/2025
5.0.0-beta-0004 304 10/10/2025
5.0.0-beta-0003 316 10/9/2025
5.0.0-beta-0002 300 10/8/2025
5.0.0-beta-0001 297 10/7/2025
4.10.0-beta-0020 358 9/19/2025
4.10.0-beta-0019 426 9/18/2025
4.10.0-beta-0018 413 9/18/2025
4.10.0-beta-0017 432 9/18/2025
4.10.0-beta-0016 427 9/18/2025
4.10.0-beta-0015 417 9/18/2025
4.10.0-beta-0014 426 9/18/2025
4.10.0-beta-0013 423 9/18/2025
4.10.0-beta-0012 427 9/18/2025
4.10.0-beta-0011 414 9/16/2025
4.10.0-beta-0010 424 9/16/2025
4.10.0-beta-0009 300 9/10/2025
4.10.0-beta-0008 268 9/10/2025
4.10.0-beta-0007 282 9/9/2025
4.10.0-beta-0006 362 8/28/2025
4.10.0-beta-0005 256 8/22/2025
4.10.0-beta-0004 260 8/22/2025
4.10.0-beta-0003 282 8/18/2025
4.10.0-beta-0002 257 8/18/2025
4.10.0-beta-0001 219 7/29/2025
4.9.1 950 7/29/2025
4.9.0 333 7/26/2025
4.9.0-beta-0005 672 7/22/2025
4.9.0-beta-0004 664 7/22/2025
4.9.0-beta-0003 661 7/22/2025
4.9.0-beta-0002 627 7/21/2025
4.9.0-beta-0001 560 7/21/2025
4.8.0 442 7/18/2025
4.8.0-beta-0004 223 7/18/2025
4.8.0-beta-0003 292 7/14/2025
4.8.0-beta-0002 289 7/14/2025
4.8.0-beta-0001 274 7/14/2025
4.7.0 560 6/25/2025
4.7.0-beta-0026 271 7/13/2025
4.7.0-beta-0025 293 7/10/2025
4.7.0-beta-0023 273 6/25/2025
4.7.0-beta-0022 285 6/24/2025
4.7.0-beta-0021 296 6/23/2025
4.7.0-beta-0020 287 6/19/2025
4.7.0-beta-0004 284 6/19/2025
4.6.6 299 6/19/2025
4.6.5 282 6/19/2025
4.6.4 278 6/19/2025
4.6.3 591 6/18/2025
4.6.2 284 6/18/2025
4.6.1 315 6/16/2025
4.6.1-beta-0005 279 6/18/2025
4.6.1-beta-0003 281 6/18/2025
4.6.1-beta-0001 279 6/16/2025
4.6.0 284 6/16/2025
4.5.0 483 6/10/2025
4.5.0-beta-0007 415 6/10/2025
4.5.0-beta-0006 401 6/9/2025
4.5.0-beta-0004 226 6/6/2025
4.5.0-beta-0002 267 6/6/2025
4.4.0 535 6/3/2025
4.4.0-beta-0025 279 6/3/2025
4.4.0-beta-0023 273 5/29/2025
4.4.0-beta-0021 286 5/29/2025
4.4.0-beta-0018 292 5/26/2025
4.4.0-beta-0017 287 5/26/2025
4.4.0-beta-0015 285 5/26/2025
4.4.0-beta-0014 286 5/26/2025
4.4.0-beta-0004 250 5/25/2025
4.2.2 497 5/24/2025
4.2.1 457 5/8/2025
4.2.0 419 4/25/2025
4.2.0-beta-0010 296 5/8/2025
4.2.0-beta-0009 300 5/8/2025
4.2.0-beta-0008 256 4/25/2025
4.2.0-beta-0001 352 4/16/2025
4.1.0 614 3/28/2025
4.1.0-beta-0001 296 3/28/2025
4.0.4 587 3/24/2025
4.0.4-beta-0001 561 3/24/2025
4.0.3 417 3/23/2025
4.0.3-beta-0007 424 3/23/2025
4.0.2 395 3/15/2025
4.0.1 516 3/5/2025
4.0.1-beta-0010 317 3/19/2025
4.0.1-beta-0009 224 3/15/2025
4.0.1-beta-0001 360 3/5/2025
4.0.0 375 3/4/2025
4.0.0-beta-0021 367 3/4/2025
4.0.0-beta-0017 354 3/4/2025
4.0.0-beta-0016 370 3/4/2025
4.0.0-beta-0010 252 3/2/2025
4.0.0-beta-0009 264 3/2/2025
4.0.0-beta-0002 266 3/1/2025
3.3.1 433 2/20/2025
3.3.0 263 2/20/2025
3.3.0-beta-0028 242 2/20/2025
3.3.0-beta-0025 280 2/19/2025
3.3.0-beta-0024 281 2/19/2025
3.3.0-beta-0004 228 2/8/2025
3.2.0 520 1/29/2025
3.2.0-beta-0027 223 1/29/2025
3.2.0-beta-0023 223 1/29/2025
3.2.0-beta-0020 228 1/29/2025
3.1.3 246 1/29/2025
3.1.2 248 1/28/2025
3.1.1 264 1/25/2025
3.1.0 237 1/25/2025
3.1.0-beta-0013 232 1/25/2025
3.1.0-beta-0006 228 1/25/2025
3.1.0-beta-0004 224 1/25/2025
3.0.0 220 1/24/2025
3.0.0-beta-0055 231 1/24/2025
3.0.0-beta-0046 220 1/23/2025
3.0.0-beta-0045 244 1/23/2025
3.0.0-beta-0043 229 1/23/2025
3.0.0-beta-0038 252 1/21/2025
3.0.0-beta-0037 228 1/21/2025
3.0.0-beta-0029 244 1/21/2025
3.0.0-beta-0028 219 1/21/2025
3.0.0-beta-0018 216 1/19/2025
3.0.0-beta-0016 215 1/14/2025
3.0.0-beta-0012 225 1/12/2025
3.0.0-beta-0008 241 1/2/2025
3.0.0-beta-0007 234 12/28/2024
3.0.0-beta-0004 223 12/22/2024
2.2.0-beta-0001 445 10/28/2024
2.1.1 856 10/28/2024
2.1.0 373 10/19/2024
2.1.0-beta-0016 237 10/19/2024
2.1.0-beta-0015 246 10/19/2024
2.1.0-beta-0014 258 10/19/2024
2.1.0-beta-0013 256 10/19/2024
2.1.0-beta-0011 275 10/18/2024
2.1.0-beta-0010 246 10/18/2024
2.1.0-beta-0004 239 10/8/2024
2.1.0-beta-0002 231 10/6/2024
2.0.2 510 10/6/2024
2.0.1 251 10/6/2024
2.0.0 330 10/4/2024
2.0.0-beta-0060 235 10/6/2024
2.0.0-beta-0059 226 10/6/2024
2.0.0-beta-0056 229 10/4/2024
2.0.0-beta-0054 250 10/3/2024
2.0.0-beta-0053 228 10/2/2024
2.0.0-beta-0052 241 10/2/2024
2.0.0-beta-0050 240 10/2/2024
2.0.0-beta-0049 241 10/2/2024
2.0.0-beta-0046 246 10/1/2024
2.0.0-beta-0044 244 9/30/2024
2.0.0-beta-0026 246 9/24/2024
2.0.0-beta-0023 245 9/23/2024
2.0.0-beta-0022 226 9/23/2024
2.0.0-beta-0020 251 9/22/2024
2.0.0-beta-0004 238 9/20/2024
2.0.0-beta-0003 246 9/20/2024
1.9.0-beta-0003 240 9/16/2024
1.9.0-beta-0001 252 9/15/2024
1.9.0-beta 239 9/15/2024
1.8.1 413 9/14/2024
1.8.1-beta-0006 235 9/14/2024
1.8.1-beta-0005 220 9/14/2024
1.8.1-beta-0004 253 9/14/2024
1.8.1-beta-0003 239 9/14/2024
1.8.1-beta-0002 253 9/14/2024
1.8.1-beta-0001 223 9/14/2024
1.8.0 307 9/12/2024
1.8.0-beta-0064 262 9/12/2024
1.8.0-beta-0063 268 9/12/2024
1.8.0-beta-0059 256 9/8/2024
1.8.0-beta-0058 239 9/8/2024
1.8.0-beta-0057 278 9/8/2024
1.8.0-beta-0054 263 9/7/2024
1.8.0-beta-0053 261 9/6/2024
1.8.0-beta-0052 249 9/6/2024
1.8.0-beta-0051 275 9/6/2024
1.8.0-beta-0044 261 9/5/2024
1.8.0-beta-0042 272 9/4/2024
1.8.0-beta-0041 244 9/4/2024
1.8.0-beta-0027 252 8/25/2024
1.8.0-beta-0022 265 8/23/2024
1.8.0-beta-0017 252 8/7/2024
1.8.0-beta-0012 197 7/28/2024
1.8.0-beta-0010 206 7/28/2024
1.7.5 300 8/23/2024
1.7.4 406 8/9/2024
1.7.3 269 8/7/2024
1.7.2 234 7/28/2024
1.7.1 226 7/28/2024
1.7.0 286 7/20/2024
1.7.0-beta-0005 229 7/20/2024
1.7.0-beta-0001 251 7/8/2024
1.6.0 276 7/8/2024
1.6.0-beta-0004 240 7/7/2024
1.5.0 271 7/6/2024
1.5.0-beta-0010 233 7/6/2024
1.5.0-beta-0006 236 7/4/2024
1.4.5 256 7/4/2024
1.4.2 262 6/30/2024
1.4.1 251 6/30/2024
1.4.0 235 6/30/2024
1.4.0-beta-0010 224 6/30/2024
1.3.1 241 6/29/2024
1.3.0 218 6/29/2024
1.3.0-beta-0014 205 6/29/2024
1.3.0-beta-0007 194 6/26/2024
1.2.0 225 6/20/2024
1.2.0-beta-0001 194 6/20/2024
1.1.0 222 6/17/2024
1.1.0-beta-0019 212 6/20/2024
1.1.0-beta-0016 213 6/19/2024
1.1.0-beta-0014 200 6/17/2024
1.1.0-beta-0013 200 6/17/2024
1.0.0 249 6/15/2024
1.0.0-alpha-0054 196 6/15/2024
1.0.0-alpha-0053 202 6/12/2024
1.0.0-alpha-0051 165 6/12/2024
1.0.0-alpha-0048 187 6/10/2024
1.0.0-alpha-0047 178 6/10/2024
1.0.0-alpha-0043 184 6/9/2024
1.0.0-alpha-0042 209 6/7/2024
1.0.0-alpha-0040 186 6/6/2024
1.0.0-alpha-0038 189 6/6/2024
1.0.0-alpha-0036 191 6/5/2024
1.0.0-alpha-0034 203 6/4/2024
1.0.0-alpha-0031 178 6/4/2024
1.0.0-alpha-0025 181 6/3/2024
1.0.0-alpha-0023 187 6/2/2024
1.0.0-alpha-0022 198 6/1/2024
1.0.0-alpha-0019 182 6/1/2024
1.0.0-alpha-0018 189 6/1/2024
1.0.0-alpha-0014 200 6/1/2024
1.0.0-alpha-0013 192 6/1/2024
1.0.0-alpha-0012 209 5/31/2024
1.0.0-alpha-0011 202 5/31/2024
1.0.0-alpha-0010 203 5/31/2024