magic.library 14.0.2

.NET 6.0
Install-Package magic.library -Version 14.0.2
dotnet add package magic.library --version 14.0.2
<PackageReference Include="magic.library" Version="14.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add magic.library --version 14.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: magic.library, 14.0.2"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install magic.library as a Cake Addin
#addin nuget:?package=magic.library&version=14.0.2

// Install magic.library as a Cake Tool
#tool nuget:?package=magic.library&version=14.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Wiring all parts of Magic together automagically

This project helps you to wire up everything related to Magic. Normally you'd use it simply like the following from your startup class in your .Net 6 Web API project.

using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using magic.library;

namespace magic.backend
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        IConfiguration Configuration { get; }

        public void ConfigureServices(IServiceCollection services)
        {
            // Initializing Magic.
            services.AddMagic(Configuration);
        }

        public void Configure(IApplicationBuilder app)
        {
            // Initializing Magic.
            app.UseMagic(Configuration);
        }
    }
}

However, you can also take more control over how things are actually wired up, by instead of using the "do all methods" called AddMagic and UseMagic, invoke some of the specialized initialization methods, you can find below.

  • IServiceCollection.AddMagicCaching
  • IServiceCollection.AddMagicHttp
  • IServiceCollection.AddMagicLogging
  • IServiceCollection.AddMagicSignals
  • IServiceCollection.AddMagicExceptions
  • IServiceCollection.AddMagicEndpoints
  • IServiceCollection.AddMagicAuthorization
  • IServiceCollection.AddMagicFileServices
  • IServiceCollection.AddMagicFileServices
  • IServiceCollection.AddMagicConfiguration
  • IServiceCollection.AddMagicScheduler
  • IServiceCollection.AddMagicMail
  • IServiceCollection.AddMagicLambda
  • IServiceCollection.AddMagicSockets

The above methods is basically what the AddMagic method actually does, and they're extension methods of IServiceCollection, that can be found in the magic.library namespace. Similar alternatives to UseMagic can be found below.

  • IApplicationBuilder.UseMagicExceptions
  • IApplicationBuilder.UseMagicStartupFiles
  • IApplicationBuilder.UseMagicScheduler
  • IApplicationBuilder.UseMagicCors

If you use these methods instead of the "do all methods", your motivation would probably be to replace one of these methods with your own implementation, to exchange the default wiring, by (for instance) using a "virtual database based file system" by creating your own service implementation of for instance IFileService from "magic.lambda.io", or use a different logging provider than the default, etc. If you wish to do this, you'd probably benefit from looking at what the default implementation of your method does, to understand the requirements from your method. Doing this is very powerful, and allows you to change the way the system behaves by default - But is also definitely considered an "advanced exercise".

Exceptions handlers

Magic allows you to provide a custom exceptions handler on a per folder level. This overrides the default exception logic with a custom exception handler expected to be named "exceptions.hl" and found within the folder hierarchy where an HTTP invocation is resolved. For instance, if you wish to create your own exception handler for a specific module called "foo", you can create an exception handler file called "/files/modules/foo/exceptions.hl", and expect this file to be invoked every time an unhandled exception occurs, anywhere inside of your "foo" folder. This allows you to transform an unhandled exception, such as for instance localising it or customising it in any ways. Your custom exception handler will be invoked with the following arguments.

  • [message] - The exception error message
  • [path] - The URL that triggered the exception
  • [field] - If the exception that was thrown declared a field, this argument will contain the name of the field
  • [status] - If the exception that was thrown declared a status code, this argument will contain the status code
  • [public] - If the exception that was thrown wants to propagate to the client this will be true

You can return a "transformed" exception from your exception handler, returning the following arguments, that will end up becoming the response object returned to the client.

  • [message] - Message to return as JSON to client
  • [field] - Field to return as JSON to client
  • [status] - Status code to decorate your HTTP response with

The default exception handler can be found in "/files/exceptions.hl", which will be invoked if no custom exception handler is declared further down in your folder hierarchy.

Project website

The source code for this repository can be found at github.com/polterguy/magic.library, and you can provide feedback, provide bug reports, etc at the same place.

Quality gates

  • Build status
  • Quality Gate Status
  • Bugs
  • Code Smells
  • Duplicated Lines (%)
  • Lines of Code
  • Maintainability Rating
  • Reliability Rating
  • Security Rating
  • Technical Debt
  • Vulnerabilities
Product Versions
.NET net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
Compatible target framework(s)
Additional computed target framework(s)
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
14.0.2 0 7/2/2022
14.0.1 0 7/2/2022
14.0.0 51 6/25/2022
13.4.28 65 6/11/2022
13.4.25 170 6/9/2022
13.4.24 76 6/9/2022
13.4.19 119 6/8/2022
13.4.3 89 6/6/2022
13.4.2 140 6/4/2022
13.4.0 157 5/31/2022
13.3.8 129 5/19/2022
13.3.7 78 5/18/2022
13.3.6 137 5/14/2022
13.3.4 226 5/9/2022
13.3.1 178 5/1/2022
13.3.0 95 5/1/2022
13.2.2 162 4/25/2022
13.2.1 111 4/25/2022
13.2.0 154 4/21/2022
13.1.1 142 4/20/2022
13.1.0 228 4/7/2022
13.0.0 170 4/5/2022
12.0.3 288 3/14/2022
11.0.7 153 3/11/2022
11.0.5 223 3/2/2022
11.0.4 199 2/22/2022
11.0.3 202 2/9/2022
11.0.2 223 2/6/2022
11.0.1 210 2/5/2022
10.0.21 200 1/28/2022
10.0.20 213 1/27/2022
10.0.19 199 1/23/2022
10.0.18 172 1/17/2022
10.0.17 182 1/14/2022
10.0.16 225 1/2/2022
10.0.15 295 12/31/2021
10.0.14 314 12/28/2021
10.0.13 368 12/23/2021
10.0.11 197 12/23/2021
10.0.10 207 12/22/2021
10.0.9 342 12/22/2021
10.0.8 229 12/22/2021
10.0.7 340 12/22/2021
10.0.6 299 12/19/2021
10.0.5 353 12/18/2021
10.0.3 169 12/16/2021
10.0.2 238 12/14/2021
10.0.1 158 12/13/2021
10.0.0 207 12/6/2021
9.9.9 956 11/29/2021
9.9.6 4,444 11/24/2021
9.9.5 173 11/23/2021
9.9.4 490 11/21/2021
9.9.3 237 11/9/2021
9.9.2 272 11/4/2021
9.9.0 388 10/30/2021
9.8.9 362 10/29/2021
9.8.7 298 10/27/2021
9.8.6 292 10/27/2021
9.8.5 349 10/26/2021
9.8.4 335 10/25/2021
9.8.3 388 10/24/2021
9.8.1 291 10/21/2021
9.8.0 378 10/20/2021
9.7.9 298 10/20/2021
9.7.8 289 10/19/2021
9.7.7 509 10/17/2021
9.7.6 432 10/17/2021
9.7.5 306 10/14/2021
9.7.1 252 10/14/2021
9.7.0 329 10/9/2021
9.6.8 314 8/30/2021
9.6.7 283 8/26/2021
9.6.6 430 8/14/2021
9.6.5 501 8/11/2021
9.6.4 325 8/10/2021
9.6.3 341 8/9/2021
9.6.2 303 8/8/2021
9.6.1 281 8/8/2021
9.5.9 402 8/5/2021
9.5.8 408 8/4/2021
9.5.3 335 7/20/2021
9.5.0 606 7/9/2021
9.4.5 350 6/29/2021
9.4.4 436 6/29/2021
9.4.0 298 6/24/2021
9.3.7 323 6/21/2021
9.3.6 371 6/21/2021
9.3.5 474 6/18/2021
9.3.4 385 6/18/2021
9.2.5 487 6/7/2021
9.2.4 402 6/6/2021
9.2.3 350 6/6/2021
9.2.2 294 6/4/2021
9.2.1 506 6/1/2021
9.2.0 432 5/26/2021
9.1.9 271 5/5/2021
9.1.8 413 5/5/2021
9.1.7 276 5/3/2021
9.1.4 305 4/21/2021
9.1.2 286 4/18/2021
9.1.1 250 4/15/2021
9.1.0 300 4/14/2021
9.0.1 365 4/12/2021
9.0.0 311 4/5/2021
8.9.92 624 3/30/2021
8.9.4 659 3/26/2021
8.9.3 655 3/19/2021
8.9.2 607 1/29/2021
8.9.1 683 1/24/2021
8.9.0 730 1/22/2021
8.7.1 1,041 11/15/2020
8.7.0 734 11/15/2020
8.6.9 680 11/8/2020
8.6.7 666 11/4/2020
8.6.6 722 11/2/2020
8.6.5 674 11/1/2020
8.6.3 727 10/30/2020
8.6.2 642 10/30/2020
8.6.1 714 10/29/2020
8.6.0 634 10/28/2020
8.5.1 652 10/26/2020
8.5.0 633 10/23/2020
8.4.6 829 10/20/2020
8.4.5 684 10/18/2020
8.4.4 708 10/17/2020
8.4.3 673 10/16/2020
8.4.2 672 10/16/2020
8.4.1 663 10/15/2020
8.4.0 751 10/13/2020
8.3.3 662 10/11/2020
8.3.2 717 10/8/2020
8.3.1 723 10/5/2020
8.3.0 709 10/3/2020
8.2.3 624 10/1/2020
8.2.2 865 9/26/2020
8.2.1 736 9/25/2020
8.2.0 788 9/25/2020
8.1.25 676 9/24/2020
8.1.24 707 9/23/2020
8.1.23 663 9/23/2020
8.1.22 700 9/21/2020
8.1.21 752 9/15/2020
8.1.20 746 9/14/2020
8.1.19 708 9/13/2020
8.1.18 704 9/13/2020
8.1.17 754 9/13/2020
8.1.16 752 9/13/2020
8.1.15 678 9/12/2020
8.1.13 593 9/11/2020
8.1.12 692 9/11/2020
8.1.11 703 9/11/2020
8.1.10 740 9/6/2020
8.1.9 738 9/3/2020
8.1.8 767 9/2/2020
8.1.7 629 8/28/2020
8.1.4 632 8/25/2020
8.1.3 773 8/18/2020
8.1.2 623 8/16/2020
8.1.1 716 8/15/2020
8.0.3 698 8/11/2020
8.0.2 715 8/7/2020
8.0.1 682 8/7/2020
8.0.0 673 8/7/2020
7.0.1 780 6/28/2020
7.0.0 767 6/28/2020
5.0.10 737 5/31/2020
5.0.9 796 5/30/2020
5.0.8 712 5/29/2020
5.0.7 699 5/29/2020
5.0.5 805 2/27/2020
5.0.4 732 2/26/2020
5.0.3 732 2/26/2020
5.0.2 750 2/25/2020
5.0.1 656 2/25/2020
5.0.0 758 2/25/2020
4.1.5 719 2/23/2020
4.1.4 808 2/23/2020
4.1.3 740 2/22/2020
4.1.2 742 2/22/2020
4.1.1 721 2/21/2020
4.1.0 733 2/21/2020
4.0.9 803 2/7/2020
4.0.8 657 2/7/2020
4.0.7 686 2/7/2020
4.0.5 720 1/28/2020
4.0.4 802 1/27/2020
4.0.3 731 1/27/2020
4.0.2 796 1/16/2020
4.0.1 816 1/11/2020
4.0.0 771 1/5/2020
3.1.7 843 12/17/2019
3.1.6 766 12/12/2019
3.1.5 723 12/12/2019
3.1.4 767 12/5/2019
3.1.3 771 12/4/2019
3.1.2 800 11/30/2019
3.1.1 942 11/26/2019
3.1.0 782 11/10/2019
3.0.4 784 11/1/2019
3.0.3 747 10/28/2019
3.0.2 770 10/28/2019
3.0.1 776 10/26/2019
3.0.0 658 10/23/2019
2.1.4 630 10/21/2019
2.1.3 733 10/21/2019
2.1.2 822 10/21/2019
2.1.1 717 10/19/2019
2.1.0 780 10/19/2019
2.0.9 706 10/18/2019
2.0.8 773 10/18/2019
2.0.7 707 10/18/2019
2.0.6 697 10/18/2019
2.0.5 732 10/18/2019
2.0.4 709 10/17/2019
2.0.3 660 10/16/2019
2.0.2 676 10/15/2019
2.0.1 669 10/14/2019
2.0.0 619 10/13/2019
1.1.7 774 10/11/2019
1.1.6 749 10/11/2019