magic.library 14.5.5

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package magic.library --version 14.5.5
                    


                    

                
NuGet\Install-Package magic.library -Version 14.5.5
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="magic.library" Version="14.5.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="magic.library" Version="14.5.5" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="magic.library" />
                    


                            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 magic.library --version 14.5.5
                    


                    

                
#r "nuget: magic.library, 14.5.5"
#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 magic.library@14.5.5
#: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=magic.library&version=14.5.5
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=magic.library&version=14.5.5
                    


                            Install as a Cake Tool

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 Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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.

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
17.3.9 955 2/17/2024
17.3.7 198 2/12/2024
17.3.6 167 2/12/2024
17.3.5 160 2/10/2024
17.3.4 152 2/9/2024
17.3.3 160 2/8/2024
17.3.2 166 2/2/2024
17.3.1 173 1/30/2024
17.2.2 145 1/30/2024
17.2.1 181 1/22/2024
17.2.0 157 1/22/2024
17.1.7 231 1/12/2024
17.1.6 187 1/11/2024
17.1.5 200 1/5/2024
17.0.1 259 1/1/2024
17.0.0 380 12/14/2023
16.11.6 255 11/14/2023
16.11.5 198 11/12/2023
16.9.0 329 10/9/2023
16.8.5 212 9/30/2023
16.8.4 199 9/25/2023
16.8.0 176 9/24/2023
16.7.51 162 9/24/2023
16.7.50 179 9/23/2023
16.7.1 223 9/4/2023
16.7.0 340 7/11/2023
16.6.13 228 7/6/2023
16.6.12 232 7/5/2023
16.6.11 213 7/5/2023
16.6.5 255 7/3/2023
16.4.4 259 7/2/2023
16.4.3 262 6/27/2023
16.4.2 250 6/25/2023
16.4.1 257 6/25/2023
16.4.0 238 6/22/2023
16.3.2 336 6/7/2023
16.3.0 358 5/28/2023
16.2.0 433 5/13/2023
16.1.10 405 5/1/2023
16.1.9 324 4/30/2023
16.1.1 348 4/20/2023
15.10.11 367 4/16/2023
15.9.40 401 4/3/2023
15.9.1 460 3/27/2023
15.9.0 469 3/24/2023
15.8.2 500 3/20/2023
15.7.0 390 3/6/2023
15.5.20 749 2/23/2023
15.5.13 556 2/13/2023
15.5.9 447 2/11/2023
15.5.2 538 2/5/2023
15.5.1 458 2/3/2023
15.5.0 519 1/28/2023
15.2.0 661 1/18/2023
15.1.0 1,137 12/28/2022
14.5.7 672 12/13/2022
14.5.5 772 12/6/2022
14.5.1 608 11/23/2022
14.5.0 558 11/18/2022
14.4.5 628 10/22/2022
14.4.2 566 10/22/2022
14.4.1 569 10/22/2022
14.4.0 595 10/17/2022
14.3.9 624 10/13/2022
14.3.6 617 10/7/2022
14.3.2 634 9/18/2022
14.3.1 711 9/12/2022
14.3.0 604 9/10/2022
14.1.3 871 8/7/2022
14.1.2 614 8/7/2022
14.1.1 629 8/7/2022
14.0.14 615 7/26/2022
14.0.12 608 7/24/2022
14.0.11 581 7/23/2022
14.0.10 604 7/23/2022
14.0.9 588 7/23/2022
14.0.8 676 7/17/2022
14.0.5 746 7/11/2022
14.0.4 676 7/7/2022
14.0.3 668 7/2/2022
14.0.2 622 7/2/2022
14.0.1 657 7/2/2022
14.0.0 646 6/25/2022
13.4.28 629 6/11/2022
13.4.25 741 6/9/2022
13.4.24 631 6/9/2022
13.4.19 685 6/8/2022
13.4.3 667 6/6/2022
13.4.2 709 6/4/2022
13.4.0 719 5/31/2022
13.3.8 698 5/19/2022
13.3.7 655 5/18/2022
13.3.6 698 5/14/2022
13.3.4 769 5/9/2022
13.3.1 711 5/1/2022
13.3.0 672 5/1/2022
13.2.2 732 4/25/2022
13.2.1 683 4/25/2022
13.2.0 717 4/21/2022
13.1.1 730 4/20/2022
13.1.0 814 4/7/2022
13.0.0 738 4/5/2022
12.0.3 910 3/14/2022
11.0.7 779 3/11/2022
11.0.5 836 3/2/2022
11.0.4 756 2/22/2022
11.0.3 760 2/9/2022
11.0.2 820 2/6/2022
11.0.1 805 2/5/2022
10.0.21 782 1/28/2022
10.0.20 791 1/27/2022
10.0.19 777 1/23/2022
10.0.18 743 1/17/2022
10.0.17 753 1/14/2022
10.0.16 615 1/2/2022
10.0.15 670 12/31/2021
10.0.14 678 12/28/2021
10.0.13 750 12/23/2021
10.0.11 538 12/23/2021
10.0.10 560 12/22/2021
10.0.9 715 12/22/2021
10.0.8 604 12/22/2021
10.0.7 760 12/22/2021
10.0.6 641 12/19/2021
10.0.5 734 12/18/2021
10.0.3 521 12/16/2021
10.0.2 607 12/14/2021
10.0.1 491 12/13/2021
10.0.0 542 12/6/2021
9.9.9 1,320 11/29/2021
9.9.6 4,792 11/24/2021
9.9.5 542 11/23/2021
9.9.4 845 11/21/2021
9.9.3 608 11/9/2021
9.9.2 637 11/4/2021
9.9.0 728 10/30/2021
9.8.9 752 10/29/2021
9.8.7 637 10/27/2021
9.8.6 646 10/27/2021
9.8.5 734 10/26/2021
9.8.4 712 10/25/2021
9.8.3 769 10/24/2021
9.8.1 637 10/21/2021
9.8.0 709 10/20/2021
9.7.9 620 10/20/2021
9.7.8 656 10/19/2021
9.7.7 887 10/17/2021
9.7.6 783 10/17/2021
9.7.5 659 10/14/2021
9.7.1 595 10/14/2021
9.7.0 674 10/9/2021
9.6.8 683 8/30/2021
9.6.7 661 8/26/2021
9.6.6 771 8/14/2021
9.6.5 881 8/11/2021
9.6.4 675 8/10/2021
9.6.3 668 8/9/2021
9.6.2 667 8/8/2021
9.6.1 624 8/8/2021
9.5.9 825 8/5/2021
9.5.8 815 8/4/2021
9.5.3 700 7/20/2021
9.5.0 1,063 7/9/2021
9.4.5 673 6/29/2021
9.4.4 816 6/29/2021
9.4.0 661 6/24/2021
9.3.7 671 6/21/2021
9.3.6 724 6/21/2021
9.3.5 848 6/18/2021
9.3.4 777 6/18/2021
9.2.5 830 6/7/2021
9.2.4 766 6/6/2021
9.2.3 706 6/6/2021
9.2.2 616 6/4/2021
9.2.1 853 6/1/2021
9.2.0 805 5/26/2021
9.1.9 631 5/5/2021
9.1.8 791 5/5/2021
9.1.7 640 5/3/2021
9.1.4 645 4/21/2021
9.1.2 628 4/18/2021
9.1.1 624 4/15/2021
9.1.0 670 4/14/2021
9.0.1 734 4/12/2021
9.0.0 637 4/5/2021
8.9.92 1,209 3/30/2021
8.9.4 1,221 3/26/2021
8.9.3 1,268 3/19/2021
8.9.2 1,255 1/29/2021
8.9.1 1,315 1/24/2021
8.9.0 1,385 1/22/2021
8.7.1 1,680 11/15/2020
8.7.0 1,382 11/15/2020
8.6.9 1,322 11/8/2020
8.6.7 1,294 11/4/2020
8.6.6 1,379 11/2/2020
8.6.5 1,361 11/1/2020
8.6.3 1,382 10/30/2020
8.6.2 1,283 10/30/2020
8.6.1 1,371 10/29/2020
8.6.0 1,331 10/28/2020
8.5.1 1,326 10/26/2020
8.5.0 1,278 10/23/2020
8.4.6 1,494 10/20/2020
8.4.5 1,380 10/18/2020
8.4.4 1,394 10/17/2020
8.4.3 1,363 10/16/2020
8.4.2 1,316 10/16/2020
8.4.1 1,310 10/15/2020
8.4.0 1,394 10/13/2020
8.3.3 1,313 10/11/2020
8.3.2 1,355 10/8/2020
8.3.1 1,375 10/5/2020
8.3.0 1,341 10/3/2020
8.2.3 1,292 10/1/2020
8.2.2 1,556 9/26/2020
8.2.1 1,426 9/25/2020
8.2.0 1,457 9/25/2020
8.1.25 1,349 9/24/2020
8.1.24 1,342 9/23/2020
8.1.23 1,276 9/23/2020
8.1.22 1,339 9/21/2020
8.1.21 1,398 9/15/2020
8.1.20 1,408 9/14/2020
8.1.19 1,379 9/13/2020
8.1.18 1,350 9/13/2020
8.1.17 1,397 9/13/2020
8.1.16 1,396 9/13/2020
8.1.15 1,328 9/12/2020
8.1.13 1,216 9/11/2020
8.1.12 1,346 9/11/2020
8.1.11 1,349 9/11/2020
8.1.10 1,383 9/6/2020
8.1.9 1,386 9/3/2020
8.1.8 1,413 9/2/2020
8.1.7 1,282 8/28/2020
8.1.4 1,287 8/25/2020
8.1.3 1,465 8/18/2020
8.1.2 1,268 8/16/2020
8.1.1 1,330 8/15/2020
8.0.3 1,345 8/11/2020
8.0.2 1,375 8/7/2020
8.0.1 1,373 8/7/2020
8.0.0 1,314 8/7/2020
7.0.1 1,428 6/28/2020
7.0.0 1,425 6/28/2020
5.0.10 1,397 5/31/2020
5.0.9 1,494 5/30/2020
5.0.8 1,364 5/29/2020
5.0.7 1,356 5/29/2020
5.0.5 1,428 2/27/2020
5.0.4 1,394 2/26/2020
5.0.3 1,384 2/26/2020
5.0.2 1,392 2/25/2020
5.0.1 1,296 2/25/2020
5.0.0 1,419 2/25/2020
4.1.5 1,358 2/23/2020
4.1.4 1,441 2/23/2020
4.1.3 1,372 2/22/2020
4.1.2 1,369 2/22/2020
4.1.1 1,357 2/21/2020
4.1.0 1,394 2/21/2020
4.0.9 1,480 2/7/2020
4.0.8 1,319 2/7/2020
4.0.7 1,340 2/7/2020
4.0.5 1,352 1/28/2020
4.0.4 1,484 1/27/2020
4.0.3 1,333 1/27/2020
4.0.2 1,480 1/16/2020
4.0.1 1,496 1/11/2020
4.0.0 1,446 1/5/2020
3.1.7 1,498 12/17/2019
3.1.6 1,390 12/12/2019
3.1.5 1,389 12/12/2019
3.1.4 1,396 12/5/2019
3.1.3 1,431 12/4/2019
3.1.2 1,457 11/30/2019
3.1.1 1,614 11/26/2019
3.1.0 1,424 11/10/2019
3.0.4 1,261 11/1/2019
3.0.3 1,425 10/28/2019
3.0.2 1,437 10/28/2019
3.0.1 1,430 10/26/2019
3.0.0 1,259 10/23/2019
2.1.4 1,057 10/21/2019
2.1.3 1,392 10/21/2019
2.1.2 1,529 10/21/2019
2.1.1 1,400 10/19/2019
2.1.0 1,453 10/19/2019
2.0.9 1,152 10/18/2019
2.0.8 1,415 10/18/2019
2.0.7 1,157 10/18/2019
2.0.6 1,141 10/18/2019
2.0.5 1,195 10/18/2019
2.0.4 1,154 10/17/2019
2.0.3 1,291 10/16/2019
2.0.2 1,281 10/15/2019
2.0.1 1,315 10/14/2019
2.0.0 1,156 10/13/2019
1.1.7 1,498 10/11/2019
1.1.6 1,438 10/11/2019