Shiny.Mediator.Contracts 4.0.0

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package Shiny.Mediator.Contracts --version 4.0.0                
NuGet\Install-Package Shiny.Mediator.Contracts -Version 4.0.0                
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="4.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Shiny.Mediator.Contracts --version 4.0.0                
#r "nuget: Shiny.Mediator.Contracts, 4.0.0"                
#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.
// Install Shiny.Mediator.Contracts as a Cake Addin
#addin nuget:?package=Shiny.Mediator.Contracts&version=4.0.0

// Install Shiny.Mediator.Contracts as a Cake Tool
#tool nuget:?package=Shiny.Mediator.Contracts&version=4.0.0                

Shiny Mediator

<a href="https://www.nuget.org/packages/Shiny.Mediator" target="_blank"> <img src="https://img.shields.io/nuget/v/Shiny.Mediator?style=for-the-badge" /> </a>

Mediator is a behavioral design pattern that lets you reduce chaotic dependencies between objects. The pattern restricts direct communications between the objects and forces them to collaborate only via a mediator object.

Shiny Mediator <NugetBadge name="Shiny.Mediator" /> is a mediator pattern implementation, but for built with ALL .NET apps in mind. We provide a TON of middleware out-of-box to get you up and rolling with hardly any effort whatsoever. Checkout our Getting Started guide to see how easy it is. Imagine using 1 line of code to add offline, caching, or validation to your code!

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

Samples & Documentation

Features

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

What Does It Solve

Problem #1 - Service & Reference Hell

Does this look familiar to you? Look at all of those injections! As your app grows, the list will only grow. I feel sorry for the dude that gets to unit test this bad boy.

public class MyViewModel(
    IConnectivity conn,
    IDataService data,
    IAuthService auth,
    IDialogsService dialogs,
    ILogger<MyViewModel> logger
) {
    // ...
    try {
        if (conn.IsConnected) 
        {
            var myData = await data.GetDataRequest();
        }
        else 
        {
            dialogs.Show("No Connection");
            // cache?
        }
    }
    catch (Exception ex) {
        dialogs.Show(ex.Message);
        logger.LogError(ex);
    }
}

With a bit of our middleware and some events, you can get here:

public class MyViewModel(IMediator mediator) : IEventHandler<ConnectivityChangedEvent>, IEventHandler<AuthChangedEvent> {
    // ...
    var myData = await mediator.Request(new GetDataRequest());

    // logging, exception handling, offline caching can all be bundle into one nice clean call without the need for coupling
}

public class GetDataRequestHandler : IRequestHandler<GetDataRequest, MyData> {

    [OfflineAvailable] // <= boom done
    public async Task<MyData> Handle(GetDataRequest request, CancellationToken cancellationToken) {
        // ...
    }
}

Problem #2 - Messages EVERYWHERE (+ Leaks)

Do you use the MessagingCenter in Xamarin.Forms? It's a great tool, but it can lead to some memory leaks if you're not careful. It also doesn't have a pipeline, so any errors in any of the responders will crash the entire chain. It doesn't have a request/response style setup (not that it was meant for it), but this means you still require other services.

public class MyViewModel
{
    public MyViewModel()
    {
        MessagingCenter.Subscribe<SomeEvent1>(this, @event => {
            // do something
        });
        MessagingCenter.Subscribe<SomeEvent2>(this, @event => {
            // do something
        });

        MessagingCenter.Send(new SomeEvent1());
        MessagingCenter.Send(new SomeEvent2());

        // and don't forget to unsubscribe
        MessagingCenter.Unsubscribe<SomeEvent1>(this);
        MessagingCenter.Unsubscribe<SomeEvent2>(this);
    }
}

Let's take a look at our mediator in action for this scenarios

public class MyViewModel : IEventHandler<SomeEvent1>, IEventHandler<SomeEvent2>
{
    public MyViewModel(IMediator mediator)
    {
        // no need to unsubscribe
        mediator.Publish(new SomeEvent1());
        mediator.Publish(new SomeEvent2());
    }
}

Problem #3 - Strongly Typed Navigation with Strongly Typed Arguments

Our amazing friends over in Prism offer the "best in class" MVVM framework. We'll them upsell you beyond that, but one of their amazing features is 'Modules'. Modules help break up your navigation registration, services, etc.

What they don't solve is providing a strongly typed nature for this stuff (not their job though). We think we can help addon to their beautiful solution.

A normal call to a navigation service might look like this:

_navigationService.NavigateAsync("MyPage", new NavigationParameters { { "MyArg", "MyValue" } });

This is great. It works, but I don't know the type OR argument requirements of "MyPage" without going to look it up. In a small project with a small dev team, this is fine. In a large project with a large dev team, this can be difficult.

Through our Shiny.Framework library we offer a GlobalNavigationService that can be used to navigate to any page in your app from anywhere, however, for the nature of this example, we'll pass our navigation service FROM our viewmodel through the mediator request to ensure proper scope.

public record MyPageNavigatonRequest(INavigationService navigator, string MyArg) : IRequest;
public class MyPageNavigationHandler : IRequestHandler<MyPageNavigatonRequest>
{
    public async Task Handle(MyPageNavigatonRequest request, CancellationToken cancellationToken)
    {
        await request.navigator.NavigateAsync("MyPage", new NavigationParameters { { "MyArg", request.MyArg } });
    }
}

Now, in your viewmodel, you can do this:

public class MyViewModel
{
    public MyViewModel(IMediator mediator)
    {
        mediator.Request(new MyPageNavigationCommand(_navigationService, "MyValue"));
    }
}

Strongly typed. No page required page knowledge from the module upfront. The other dev team of the module can define HOW things work.

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 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net8.0

    • No dependencies.
  • net9.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.0.2 26 a day ago
4.0.1 345 11 days ago
4.0.1-beta-0009 26 a day ago
4.0.1-beta-0001 261 11 days ago
4.0.0 253 11 days ago
4.0.0-beta-0021 244 11 days ago
4.0.0-beta-0017 236 11 days ago
4.0.0-beta-0016 255 11 days ago
4.0.0-beta-0010 142 13 days ago
4.0.0-beta-0009 143 14 days ago
4.0.0-beta-0002 139 15 days ago
3.3.1 284 24 days ago
3.3.0 141 24 days ago
3.3.0-beta-0028 127 24 days ago
3.3.0-beta-0025 160 25 days ago
3.3.0-beta-0024 164 25 days ago
3.3.0-beta-0004 123 a month ago
3.2.0 409 2 months ago
3.2.0-beta-0027 113 2 months ago
3.2.0-beta-0023 121 2 months ago
3.2.0-beta-0020 114 2 months ago
3.1.3 126 2 months ago
3.1.2 133 2 months ago
3.1.1 155 2 months ago
3.1.0 129 2 months ago
3.1.0-beta-0013 114 2 months ago
3.1.0-beta-0006 116 2 months ago
3.1.0-beta-0004 121 2 months ago
3.0.0 123 2 months ago
3.0.0-beta-0055 114 2 months ago
3.0.0-beta-0046 114 2 months ago
3.0.0-beta-0045 122 2 months ago
3.0.0-beta-0043 122 2 months ago
3.0.0-beta-0038 141 2 months ago
3.0.0-beta-0037 122 2 months ago
3.0.0-beta-0029 132 2 months ago
3.0.0-beta-0028 121 2 months ago
3.0.0-beta-0018 121 2 months ago
3.0.0-beta-0016 104 2 months ago
3.0.0-beta-0012 118 2 months ago
3.0.0-beta-0008 133 2 months ago
3.0.0-beta-0007 135 3 months ago
3.0.0-beta-0004 125 3 months ago
2.2.0-beta-0001 269 5 months ago
2.1.1 610 5 months ago
2.1.0 280 5 months ago
2.1.0-beta-0016 138 5 months ago
2.1.0-beta-0015 144 5 months ago
2.1.0-beta-0014 152 5 months ago
2.1.0-beta-0013 150 5 months ago
2.1.0-beta-0011 166 5 months ago
2.1.0-beta-0010 149 5 months ago
2.1.0-beta-0004 133 5 months ago
2.1.0-beta-0002 128 5 months ago
2.0.2 410 5 months ago
2.0.1 147 5 months ago
2.0.0 214 5 months ago
2.0.0-beta-0060 129 5 months ago
2.0.0-beta-0059 121 5 months ago
2.0.0-beta-0056 130 5 months ago
2.0.0-beta-0054 135 5 months ago
2.0.0-beta-0053 124 5 months ago
2.0.0-beta-0052 136 5 months ago
2.0.0-beta-0050 141 5 months ago
2.0.0-beta-0049 136 5 months ago
2.0.0-beta-0046 145 5 months ago
2.0.0-beta-0044 143 6 months ago
2.0.0-beta-0026 147 6 months ago
2.0.0-beta-0023 134 6 months ago
2.0.0-beta-0022 127 6 months ago
2.0.0-beta-0020 153 6 months ago
2.0.0-beta-0004 137 6 months ago
2.0.0-beta-0003 144 6 months ago
1.9.0-beta-0003 140 6 months ago
1.9.0-beta-0001 146 6 months ago
1.9.0-beta 141 6 months ago
1.8.1 322 6 months ago
1.8.1-beta-0006 136 6 months ago
1.8.1-beta-0005 140 6 months ago
1.8.1-beta-0004 150 6 months ago
1.8.1-beta-0003 141 6 months ago
1.8.1-beta-0002 156 6 months ago
1.8.1-beta-0001 144 6 months ago
1.8.0 214 6 months ago
1.8.0-beta-0064 169 6 months ago
1.8.0-beta-0063 172 6 months ago
1.8.0-beta-0059 158 6 months ago
1.8.0-beta-0058 144 6 months ago
1.8.0-beta-0057 177 6 months ago
1.8.0-beta-0054 167 6 months ago
1.8.0-beta-0053 179 6 months ago
1.8.0-beta-0052 159 6 months ago
1.8.0-beta-0051 181 6 months ago
1.8.0-beta-0044 170 6 months ago
1.8.0-beta-0042 163 6 months ago
1.8.0-beta-0041 163 6 months ago
1.8.0-beta-0027 173 7 months ago
1.8.0-beta-0022 173 7 months ago
1.8.0-beta-0017 166 7 months ago
1.8.0-beta-0012 112 8 months ago
1.8.0-beta-0010 117 8 months ago
1.7.5 216 7 months ago
1.7.4 327 7 months ago
1.7.3 171 7 months ago
1.7.2 148 8 months ago
1.7.1 127 8 months ago
1.7.0 189 8 months ago
1.7.0-beta-0005 142 8 months ago
1.7.0-beta-0001 155 8 months ago
1.6.0 181 8 months ago
1.6.0-beta-0004 146 8 months ago
1.5.0 178 8 months ago
1.5.0-beta-0010 150 8 months ago
1.5.0-beta-0006 150 8 months ago
1.4.5 179 8 months ago
1.4.2 173 9 months ago
1.4.1 163 9 months ago
1.4.0 155 9 months ago
1.4.0-beta-0010 144 9 months ago
1.3.1 163 9 months ago
1.3.0 156 9 months ago
1.3.0-beta-0014 135 9 months ago
1.3.0-beta-0007 125 9 months ago
1.2.0 165 9 months ago
1.2.0-beta-0001 135 9 months ago
1.1.0 158 9 months ago
1.1.0-beta-0019 141 9 months ago
1.1.0-beta-0016 140 9 months ago
1.1.0-beta-0014 142 9 months ago
1.1.0-beta-0013 132 9 months ago
1.0.0 171 9 months ago
1.0.0-alpha-0054 140 9 months ago
1.0.0-alpha-0053 140 9 months ago
1.0.0-alpha-0051 118 9 months ago
1.0.0-alpha-0048 127 9 months ago
1.0.0-alpha-0047 124 9 months ago
1.0.0-alpha-0043 128 9 months ago
1.0.0-alpha-0042 148 9 months ago
1.0.0-alpha-0040 127 9 months ago
1.0.0-alpha-0038 132 9 months ago
1.0.0-alpha-0036 129 9 months ago
1.0.0-alpha-0034 145 9 months ago
1.0.0-alpha-0031 127 9 months ago
1.0.0-alpha-0025 132 9 months ago
1.0.0-alpha-0023 130 9 months ago
1.0.0-alpha-0022 138 9 months ago
1.0.0-alpha-0019 125 9 months ago
1.0.0-alpha-0018 131 9 months ago
1.0.0-alpha-0014 135 9 months ago
1.0.0-alpha-0013 135 9 months ago
1.0.0-alpha-0012 142 10 months ago
1.0.0-alpha-0011 145 10 months ago
1.0.0-alpha-0010 147 10 months ago