Shiny.Mediator.Resilience 3.1.0-beta-0013

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

// Install Shiny.Mediator.Resilience as a Cake Tool
#tool nuget:?package=Shiny.Mediator.Resilience&version=3.1.0-beta-0013&prerelease                

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.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.0.1 29 21 hours ago
4.0.1-beta-0001 26 21 hours ago
4.0.0 39 2 days ago
4.0.0-beta-0021 37 2 days ago
4.0.0-beta-0017 37 2 days ago
4.0.0-beta-0016 39 2 days ago
4.0.0-beta-0010 73 4 days ago
4.0.0-beta-0009 61 4 days ago
4.0.0-beta-0002 62 5 days ago
3.3.1 135 14 days ago
3.3.0 83 14 days ago
3.3.0-beta-0028 77 14 days ago
3.3.0-beta-0025 75 15 days ago
3.3.0-beta-0024 78 15 days ago
3.3.0-beta-0004 66 a month ago
3.2.0 147 a month ago
3.2.0-beta-0027 70 a month ago
3.2.0-beta-0023 74 a month ago
3.2.0-beta-0020 71 a month ago
3.1.3 74 a month ago
3.1.2 72 a month ago
3.1.1 76 a month ago
3.1.0 79 a month ago
3.1.0-beta-0013 66 a month ago
3.1.0-beta-0006 74 a month ago
3.1.0-beta-0004 72 a month ago
3.0.0 68 a month ago
3.0.0-beta-0055 65 a month ago
3.0.0-beta-0046 74 a month ago
3.0.0-beta-0045 74 a month ago
3.0.0-beta-0043 77 a month ago
3.0.0-beta-0038 75 a month ago
3.0.0-beta-0037 78 a month ago
3.0.0-beta-0029 67 a month ago
3.0.0-beta-0028 73 a month ago
3.0.0-beta-0018 66 a month ago
3.0.0-beta-0016 61 2 months ago
3.0.0-beta-0012 63 2 months ago
3.0.0-beta-0008 91 2 months ago
3.0.0-beta-0007 73 2 months ago
3.0.0-beta-0004 78 2 months ago
2.2.0-beta-0001 72 4 months ago
2.1.1 198 4 months ago
2.1.0 138 4 months ago
2.1.0-beta-0016 81 4 months ago
2.1.0-beta-0015 80 4 months ago
2.1.0-beta-0014 91 4 months ago
2.1.0-beta-0013 95 4 months ago
2.1.0-beta-0011 110 5 months ago
2.1.0-beta-0010 102 5 months ago
2.1.0-beta-0004 73 5 months ago
2.1.0-beta-0002 70 5 months ago
2.0.2 98 5 months ago
2.0.1 90 5 months ago
2.0.0 110 5 months ago
2.0.0-beta-0060 81 5 months ago
2.0.0-beta-0059 99 5 months ago
2.0.0-beta-0056 67 5 months ago
2.0.0-beta-0054 72 5 months ago
2.0.0-beta-0053 73 5 months ago
2.0.0-beta-0052 77 5 months ago
2.0.0-beta-0050 71 5 months ago
2.0.0-beta-0049 71 5 months ago
2.0.0-beta-0046 72 5 months ago
2.0.0-beta-0044 69 5 months ago
2.0.0-beta-0026 76 5 months ago
2.0.0-beta-0023 82 5 months ago
2.0.0-beta-0022 75 5 months ago
2.0.0-beta-0020 74 5 months ago
2.0.0-beta-0004 76 5 months ago
2.0.0-beta-0003 79 5 months ago
1.9.0-beta-0003 104 6 months ago
1.9.0-beta-0001 94 6 months ago
1.9.0-beta 98 6 months ago
1.8.1 122 6 months ago
1.8.1-beta-0006 92 6 months ago
1.8.1-beta-0005 90 6 months ago
1.8.1-beta-0004 91 6 months ago
1.8.1-beta-0003 84 6 months ago
1.8.1-beta-0002 91 6 months ago
1.8.1-beta-0001 89 6 months ago
1.8.0 122 6 months ago
1.8.0-beta-0064 90 6 months ago
1.8.0-beta-0063 94 6 months ago
1.8.0-beta-0059 83 6 months ago
1.8.0-beta-0058 79 6 months ago
1.8.0-beta-0057 80 6 months ago
1.8.0-beta-0054 96 6 months ago
1.8.0-beta-0053 102 6 months ago
1.8.0-beta-0052 74 6 months ago
1.8.0-beta-0051 94 6 months ago
1.8.0-beta-0044 100 6 months ago
1.8.0-beta-0042 93 6 months ago
1.8.0-beta-0041 93 6 months ago
1.8.0-beta-0027 115 6 months ago
1.8.0-beta-0022 108 6 months ago
1.8.0-beta-0017 96 7 months ago
1.8.0-beta-0012 68 7 months ago
1.8.0-beta-0010 76 7 months ago
1.7.5 131 6 months ago
1.7.4 125 7 months ago
1.7.3 108 7 months ago
1.7.2 82 7 months ago
1.7.1 75 7 months ago
1.7.0 109 7 months ago
1.7.0-beta-0005 93 7 months ago
1.7.0-beta-0001 98 8 months ago
1.6.0 96 8 months ago
1.6.0-beta-0004 98 8 months ago
1.5.0 121 8 months ago
1.5.0-beta-0010 117 8 months ago
1.5.0-beta-0006 95 8 months ago
1.4.5 124 8 months ago
1.4.2 118 8 months ago
1.4.1 124 8 months ago
1.4.0 109 8 months ago
1.4.0-beta-0010 101 8 months ago
1.3.1 112 8 months ago
1.3.0 111 8 months ago
1.3.0-beta-0014 88 8 months ago
1.3.0-beta-0007 100 8 months ago
1.2.0 116 8 months ago
1.2.0-beta-0001 98 8 months ago
1.1.0 131 9 months ago
1.1.0-beta-0019 108 8 months ago
1.1.0-beta-0016 100 9 months ago
1.1.0-beta-0014 107 9 months ago
1.1.0-beta-0013 110 9 months ago