magic.library 17.3.9

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package magic.library --version 17.3.9
                    


                    

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


                            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 17.3.9
                    


                    

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


                            Install as a Cake Addin
                        

                    

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


                            Install as a Cake Tool

magic.library - Tying Magic together

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 8 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.

Magic's GitHub project page

Magic is 100% Open Source and you can find the primary project GitHub page here.

Project website for magic.lambda.library

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.

  • Build status
  • Quality Gate Status
  • Bugs
  • Code Smells
  • Duplicated Lines (%)
  • Lines of Code
  • Maintainability Rating
  • Reliability Rating
  • Security Rating
  • Technical Debt
  • Vulnerabilities

The projects is copyright Thomas Hansen 2023 - 2024, and professionally maintained by AINIRO.IO.

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.

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 1,450 2/17/2024
17.3.7 248 2/12/2024
17.3.6 239 2/12/2024
17.3.5 224 2/10/2024
17.3.4 204 2/9/2024
17.3.3 208 2/8/2024
17.3.2 222 2/2/2024
17.3.1 240 1/30/2024
17.2.2 216 1/30/2024
17.2.1 230 1/22/2024
17.2.0 207 1/22/2024
17.1.7 278 1/12/2024
17.1.6 235 1/11/2024
17.1.5 260 1/5/2024
17.0.1 318 1/1/2024
17.0.0 447 12/14/2023
16.11.6 309 11/14/2023
16.11.5 268 11/12/2023
16.9.0 391 10/9/2023
16.8.5 250 9/30/2023
16.8.4 248 9/25/2023
16.8.0 214 9/24/2023
16.7.51 204 9/24/2023
16.7.50 233 9/23/2023
16.7.1 294 9/4/2023
16.7.0 402 7/11/2023
16.6.13 271 7/6/2023
16.6.12 299 7/5/2023
16.6.11 294 7/5/2023
16.6.5 343 7/3/2023
16.4.4 331 7/2/2023
16.4.3 307 6/27/2023
16.4.2 333 6/25/2023
16.4.1 334 6/25/2023
16.4.0 327 6/22/2023
16.3.2 411 6/7/2023
16.3.0 447 5/28/2023
16.2.0 530 5/13/2023
16.1.10 455 5/1/2023
16.1.9 423 4/30/2023
16.1.1 429 4/20/2023
15.10.11 462 4/16/2023
15.9.40 469 4/3/2023
15.9.1 541 3/27/2023
15.9.0 545 3/24/2023
15.8.2 582 3/20/2023
15.7.0 477 3/6/2023
15.5.20 808 2/23/2023
15.5.13 633 2/13/2023
15.5.9 528 2/11/2023
15.5.2 617 2/5/2023
15.5.1 547 2/3/2023
15.5.0 583 1/28/2023
15.2.0 717 1/18/2023
15.1.0 1,239 12/28/2022
14.5.7 761 12/13/2022
14.5.5 856 12/6/2022
14.5.1 685 11/23/2022
14.5.0 632 11/18/2022
14.4.5 694 10/22/2022
14.4.2 654 10/22/2022
14.4.1 656 10/22/2022
14.4.0 679 10/17/2022
14.3.9 690 10/13/2022
14.3.6 683 10/7/2022
14.3.2 721 9/18/2022
14.3.1 797 9/12/2022
14.3.0 731 9/10/2022
14.1.3 955 8/7/2022
14.1.2 687 8/7/2022
14.1.1 727 8/7/2022
14.0.14 694 7/26/2022
14.0.12 677 7/24/2022
14.0.11 651 7/23/2022
14.0.10 687 7/23/2022
14.0.9 701 7/23/2022
14.0.8 758 7/17/2022
14.0.5 846 7/11/2022
14.0.4 737 7/7/2022
14.0.3 736 7/2/2022
14.0.2 706 7/2/2022
14.0.1 752 7/2/2022
14.0.0 737 6/25/2022
13.4.28 719 6/11/2022
13.4.25 823 6/9/2022
13.4.24 719 6/9/2022
13.4.19 773 6/8/2022
13.4.3 755 6/6/2022
13.4.2 794 6/4/2022
13.4.0 821 5/31/2022
13.3.8 771 5/19/2022
13.3.7 755 5/18/2022
13.3.6 768 5/14/2022
13.3.4 843 5/9/2022
13.3.1 784 5/1/2022
13.3.0 787 5/1/2022
13.2.2 820 4/25/2022
13.2.1 755 4/25/2022
13.2.0 790 4/21/2022
13.1.1 818 4/20/2022
13.1.0 927 4/7/2022
13.0.0 803 4/5/2022
12.0.3 1,019 3/14/2022
11.0.7 850 3/11/2022
11.0.5 931 3/2/2022
11.0.4 847 2/22/2022
11.0.3 858 2/9/2022
11.0.2 916 2/6/2022
11.0.1 877 2/5/2022
10.0.21 879 1/28/2022
10.0.20 887 1/27/2022
10.0.19 839 1/23/2022
10.0.18 813 1/17/2022
10.0.17 826 1/14/2022
10.0.16 709 1/2/2022
10.0.15 757 12/31/2021
10.0.14 765 12/28/2021
10.0.13 843 12/23/2021
10.0.11 613 12/23/2021
10.0.10 636 12/22/2021
10.0.9 787 12/22/2021
10.0.8 685 12/22/2021
10.0.7 851 12/22/2021
10.0.6 720 12/19/2021
10.0.5 832 12/18/2021
10.0.3 606 12/16/2021
10.0.2 720 12/14/2021
10.0.1 569 12/13/2021
10.0.0 622 12/6/2021
9.9.9 1,405 11/29/2021
9.9.6 4,878 11/24/2021
9.9.5 619 11/23/2021
9.9.4 935 11/21/2021
9.9.3 693 11/9/2021
9.9.2 734 11/4/2021
9.9.0 813 10/30/2021
9.8.9 840 10/29/2021
9.8.7 703 10/27/2021
9.8.6 736 10/27/2021
9.8.5 820 10/26/2021
9.8.4 791 10/25/2021
9.8.3 848 10/24/2021
9.8.1 713 10/21/2021
9.8.0 802 10/20/2021
9.7.9 694 10/20/2021
9.7.8 772 10/19/2021
9.7.7 951 10/17/2021
9.7.6 866 10/17/2021
9.7.5 742 10/14/2021
9.7.1 677 10/14/2021
9.7.0 779 10/9/2021
9.6.8 761 8/30/2021
9.6.7 732 8/26/2021
9.6.6 834 8/14/2021
9.6.5 972 8/11/2021
9.6.4 773 8/10/2021
9.6.3 728 8/9/2021
9.6.2 755 8/8/2021
9.6.1 730 8/8/2021
9.5.9 924 8/5/2021
9.5.8 924 8/4/2021
9.5.3 771 7/20/2021
9.5.0 1,154 7/9/2021
9.4.5 798 6/29/2021
9.4.4 912 6/29/2021
9.4.0 729 6/24/2021
9.3.7 758 6/21/2021
9.3.6 810 6/21/2021
9.3.5 932 6/18/2021
9.3.4 864 6/18/2021
9.2.5 941 6/7/2021
9.2.4 849 6/6/2021
9.2.3 805 6/6/2021
9.2.2 709 6/4/2021
9.2.1 943 6/1/2021
9.2.0 892 5/26/2021
9.1.9 729 5/5/2021
9.1.8 888 5/5/2021
9.1.7 748 5/3/2021
9.1.4 739 4/21/2021
9.1.2 714 4/18/2021
9.1.1 720 4/15/2021
9.1.0 733 4/14/2021
9.0.1 812 4/12/2021
9.0.0 726 4/5/2021
8.9.92 1,308 3/30/2021
8.9.4 1,301 3/26/2021
8.9.3 1,371 3/19/2021
8.9.2 1,352 1/29/2021
8.9.1 1,381 1/24/2021
8.9.0 1,491 1/22/2021
8.7.1 1,768 11/15/2020
8.7.0 1,484 11/15/2020
8.6.9 1,423 11/8/2020
8.6.7 1,410 11/4/2020
8.6.6 1,495 11/2/2020
8.6.5 1,474 11/1/2020
8.6.3 1,498 10/30/2020
8.6.2 1,361 10/30/2020
8.6.1 1,483 10/29/2020
8.6.0 1,418 10/28/2020
8.5.1 1,446 10/26/2020
8.5.0 1,393 10/23/2020
8.4.6 1,602 10/20/2020
8.4.5 1,488 10/18/2020
8.4.4 1,469 10/17/2020
8.4.3 1,469 10/16/2020
8.4.2 1,453 10/16/2020
8.4.1 1,405 10/15/2020
8.4.0 1,514 10/13/2020
8.3.3 1,420 10/11/2020
8.3.2 1,462 10/8/2020
8.3.1 1,495 10/5/2020
8.3.0 1,434 10/3/2020
8.2.3 1,411 10/1/2020
8.2.2 1,636 9/26/2020
8.2.1 1,517 9/25/2020
8.2.0 1,567 9/25/2020
8.1.25 1,463 9/24/2020
8.1.24 1,436 9/23/2020
8.1.23 1,365 9/23/2020
8.1.22 1,420 9/21/2020
8.1.21 1,496 9/15/2020
8.1.20 1,528 9/14/2020
8.1.19 1,469 9/13/2020
8.1.18 1,450 9/13/2020
8.1.17 1,511 9/13/2020
8.1.16 1,496 9/13/2020
8.1.15 1,425 9/12/2020
8.1.13 1,324 9/11/2020
8.1.12 1,473 9/11/2020
8.1.11 1,461 9/11/2020
8.1.10 1,472 9/6/2020
8.1.9 1,483 9/3/2020
8.1.8 1,513 9/2/2020
8.1.7 1,405 8/28/2020
8.1.4 1,392 8/25/2020
8.1.3 1,564 8/18/2020
8.1.2 1,352 8/16/2020
8.1.1 1,430 8/15/2020
8.0.3 1,457 8/11/2020
8.0.2 1,493 8/7/2020
8.0.1 1,471 8/7/2020
8.0.0 1,399 8/7/2020
7.0.1 1,518 6/28/2020
7.0.0 1,521 6/28/2020
5.0.10 1,510 5/31/2020
5.0.9 1,607 5/30/2020
5.0.8 1,436 5/29/2020
5.0.7 1,478 5/29/2020
5.0.5 1,540 2/27/2020
5.0.4 1,475 2/26/2020
5.0.3 1,480 2/26/2020
5.0.2 1,470 2/25/2020
5.0.1 1,397 2/25/2020
5.0.0 1,526 2/25/2020
4.1.5 1,449 2/23/2020
4.1.4 1,545 2/23/2020
4.1.3 1,462 2/22/2020
4.1.2 1,477 2/22/2020
4.1.1 1,430 2/21/2020
4.1.0 1,495 2/21/2020
4.0.9 1,574 2/7/2020
4.0.8 1,399 2/7/2020
4.0.7 1,446 2/7/2020
4.0.5 1,472 1/28/2020
4.0.4 1,563 1/27/2020
4.0.3 1,430 1/27/2020
4.0.2 1,595 1/16/2020
4.0.1 1,586 1/11/2020
4.0.0 1,539 1/5/2020
3.1.7 1,587 12/17/2019
3.1.6 1,519 12/12/2019
3.1.5 1,502 12/12/2019
3.1.4 1,478 12/5/2019
3.1.3 1,532 12/4/2019
3.1.2 1,579 11/30/2019
3.1.1 1,700 11/26/2019
3.1.0 1,526 11/10/2019
3.0.4 1,357 11/1/2019
3.0.3 1,522 10/28/2019
3.0.2 1,540 10/28/2019
3.0.1 1,544 10/26/2019
3.0.0 1,356 10/23/2019
2.1.4 1,163 10/21/2019
2.1.3 1,482 10/21/2019
2.1.2 1,627 10/21/2019
2.1.1 1,506 10/19/2019
2.1.0 1,573 10/19/2019
2.0.9 1,253 10/18/2019
2.0.8 1,535 10/18/2019
2.0.7 1,284 10/18/2019
2.0.6 1,245 10/18/2019
2.0.5 1,286 10/18/2019
2.0.4 1,246 10/17/2019
2.0.3 1,386 10/16/2019
2.0.2 1,381 10/15/2019
2.0.1 1,416 10/14/2019
2.0.0 1,271 10/13/2019
1.1.7 1,616 10/11/2019
1.1.6 1,554 10/11/2019