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. 
#addin nuget:?package=magic.library&version=17.3.9
                    


                            Install magic.library as a Cake Addin
                        

                    

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


                            Install magic.library 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 908 2/17/2024
17.3.7 169 2/12/2024
17.3.6 136 2/12/2024
17.3.5 127 2/10/2024
17.3.4 125 2/9/2024
17.3.3 131 2/8/2024
17.3.2 136 2/2/2024
17.3.1 143 1/30/2024
17.2.2 113 1/30/2024
17.2.1 153 1/22/2024
17.2.0 129 1/22/2024
17.1.7 199 1/12/2024
17.1.6 160 1/11/2024
17.1.5 168 1/5/2024
17.0.1 226 1/1/2024
17.0.0 353 12/14/2023
16.11.6 247 11/14/2023
16.11.5 190 11/12/2023
16.9.0 309 10/9/2023
16.8.5 194 9/30/2023
16.8.4 184 9/25/2023
16.8.0 154 9/24/2023
16.7.51 150 9/24/2023
16.7.50 164 9/23/2023
16.7.1 208 9/4/2023
16.7.0 322 7/11/2023
16.6.13 209 7/6/2023
16.6.12 206 7/5/2023
16.6.11 195 7/5/2023
16.6.5 233 7/3/2023
16.4.4 232 7/2/2023
16.4.3 245 6/27/2023
16.4.2 234 6/25/2023
16.4.1 234 6/25/2023
16.4.0 219 6/22/2023
16.3.2 317 6/7/2023
16.3.0 331 5/28/2023
16.2.0 407 5/13/2023
16.1.10 386 5/1/2023
16.1.9 305 4/30/2023
16.1.1 327 4/20/2023
15.10.11 348 4/16/2023
15.9.40 381 4/3/2023
15.9.1 439 3/27/2023
15.9.0 444 3/24/2023
15.8.2 482 3/20/2023
15.7.0 364 3/6/2023
15.5.20 732 2/23/2023
15.5.13 534 2/13/2023
15.5.9 429 2/11/2023
15.5.2 510 2/5/2023
15.5.1 432 2/3/2023
15.5.0 499 1/28/2023
15.2.0 644 1/18/2023
15.1.0 1,114 12/28/2022
14.5.7 652 12/13/2022
14.5.5 755 12/6/2022
14.5.1 589 11/23/2022
14.5.0 536 11/18/2022
14.4.5 613 10/22/2022
14.4.2 543 10/22/2022
14.4.1 545 10/22/2022
14.4.0 578 10/17/2022
14.3.9 608 10/13/2022
14.3.6 601 10/7/2022
14.3.2 615 9/18/2022
14.3.1 692 9/12/2022
14.3.0 585 9/10/2022
14.1.3 852 8/7/2022
14.1.2 596 8/7/2022
14.1.1 605 8/7/2022
14.0.14 597 7/26/2022
14.0.12 587 7/24/2022
14.0.11 563 7/23/2022
14.0.10 583 7/23/2022
14.0.9 565 7/23/2022
14.0.8 653 7/17/2022
14.0.5 722 7/11/2022
14.0.4 657 7/7/2022
14.0.3 649 7/2/2022
14.0.2 597 7/2/2022
14.0.1 639 7/2/2022
14.0.0 618 6/25/2022
13.4.28 609 6/11/2022
13.4.25 720 6/9/2022
13.4.24 611 6/9/2022
13.4.19 665 6/8/2022
13.4.3 641 6/6/2022
13.4.2 676 6/4/2022
13.4.0 697 5/31/2022
13.3.8 677 5/19/2022
13.3.7 632 5/18/2022
13.3.6 676 5/14/2022
13.3.4 750 5/9/2022
13.3.1 683 5/1/2022
13.3.0 641 5/1/2022
13.2.2 702 4/25/2022
13.2.1 659 4/25/2022
13.2.0 693 4/21/2022
13.1.1 706 4/20/2022
13.1.0 782 4/7/2022
13.0.0 717 4/5/2022
12.0.3 880 3/14/2022
11.0.7 757 3/11/2022
11.0.5 814 3/2/2022
11.0.4 734 2/22/2022
11.0.3 737 2/9/2022
11.0.2 792 2/6/2022
11.0.1 783 2/5/2022
10.0.21 750 1/28/2022
10.0.20 767 1/27/2022
10.0.19 754 1/23/2022
10.0.18 721 1/17/2022
10.0.17 731 1/14/2022
10.0.16 584 1/2/2022
10.0.15 642 12/31/2021
10.0.14 653 12/28/2021
10.0.13 724 12/23/2021
10.0.11 513 12/23/2021
10.0.10 534 12/22/2021
10.0.9 690 12/22/2021
10.0.8 580 12/22/2021
10.0.7 733 12/22/2021
10.0.6 617 12/19/2021
10.0.5 711 12/18/2021
10.0.3 495 12/16/2021
10.0.2 575 12/14/2021
10.0.1 465 12/13/2021
10.0.0 512 12/6/2021
9.9.9 1,299 11/29/2021
9.9.6 4,768 11/24/2021
9.9.5 518 11/23/2021
9.9.4 819 11/21/2021
9.9.3 585 11/9/2021
9.9.2 604 11/4/2021
9.9.0 705 10/30/2021
9.8.9 727 10/29/2021
9.8.7 612 10/27/2021
9.8.6 620 10/27/2021
9.8.5 713 10/26/2021
9.8.4 686 10/25/2021
9.8.3 740 10/24/2021
9.8.1 610 10/21/2021
9.8.0 684 10/20/2021
9.7.9 599 10/20/2021
9.7.8 631 10/19/2021
9.7.7 866 10/17/2021
9.7.6 761 10/17/2021
9.7.5 637 10/14/2021
9.7.1 575 10/14/2021
9.7.0 651 10/9/2021
9.6.8 661 8/30/2021
9.6.7 639 8/26/2021
9.6.6 750 8/14/2021
9.6.5 854 8/11/2021
9.6.4 647 8/10/2021
9.6.3 645 8/9/2021
9.6.2 637 8/8/2021
9.6.1 595 8/8/2021
9.5.9 793 8/5/2021
9.5.8 787 8/4/2021
9.5.3 672 7/20/2021
9.5.0 1,040 7/9/2021
9.4.5 649 6/29/2021
9.4.4 795 6/29/2021
9.4.0 640 6/24/2021
9.3.7 647 6/21/2021
9.3.6 700 6/21/2021
9.3.5 826 6/18/2021
9.3.4 756 6/18/2021
9.2.5 806 6/7/2021
9.2.4 744 6/6/2021
9.2.3 681 6/6/2021
9.2.2 589 6/4/2021
9.2.1 825 6/1/2021
9.2.0 781 5/26/2021
9.1.9 601 5/5/2021
9.1.8 754 5/5/2021
9.1.7 612 5/3/2021
9.1.4 619 4/21/2021
9.1.2 605 4/18/2021
9.1.1 592 4/15/2021
9.1.0 647 4/14/2021
9.0.1 712 4/12/2021
9.0.0 609 4/5/2021
8.9.92 1,183 3/30/2021
8.9.4 1,194 3/26/2021
8.9.3 1,237 3/19/2021
8.9.2 1,220 1/29/2021
8.9.1 1,288 1/24/2021
8.9.0 1,352 1/22/2021
8.7.1 1,653 11/15/2020
8.7.0 1,357 11/15/2020
8.6.9 1,295 11/8/2020
8.6.7 1,265 11/4/2020
8.6.6 1,352 11/2/2020
8.6.5 1,332 11/1/2020
8.6.3 1,354 10/30/2020
8.6.2 1,257 10/30/2020
8.6.1 1,345 10/29/2020
8.6.0 1,306 10/28/2020
8.5.1 1,295 10/26/2020
8.5.0 1,246 10/23/2020
8.4.6 1,463 10/20/2020
8.4.5 1,347 10/18/2020
8.4.4 1,368 10/17/2020
8.4.3 1,337 10/16/2020
8.4.2 1,283 10/16/2020
8.4.1 1,282 10/15/2020
8.4.0 1,361 10/13/2020
8.3.3 1,283 10/11/2020
8.3.2 1,327 10/8/2020
8.3.1 1,342 10/5/2020
8.3.0 1,306 10/3/2020
8.2.3 1,252 10/1/2020
8.2.2 1,532 9/26/2020
8.2.1 1,392 9/25/2020
8.2.0 1,425 9/25/2020
8.1.25 1,322 9/24/2020
8.1.24 1,314 9/23/2020
8.1.23 1,242 9/23/2020
8.1.22 1,314 9/21/2020
8.1.21 1,373 9/15/2020
8.1.20 1,379 9/14/2020
8.1.19 1,352 9/13/2020
8.1.18 1,320 9/13/2020
8.1.17 1,370 9/13/2020
8.1.16 1,369 9/13/2020
8.1.15 1,294 9/12/2020
8.1.13 1,189 9/11/2020
8.1.12 1,314 9/11/2020
8.1.11 1,317 9/11/2020
8.1.10 1,359 9/6/2020
8.1.9 1,357 9/3/2020
8.1.8 1,383 9/2/2020
8.1.7 1,251 8/28/2020
8.1.4 1,254 8/25/2020
8.1.3 1,431 8/18/2020
8.1.2 1,244 8/16/2020
8.1.1 1,304 8/15/2020
8.0.3 1,319 8/11/2020
8.0.2 1,340 8/7/2020
8.0.1 1,341 8/7/2020
8.0.0 1,290 8/7/2020
7.0.1 1,399 6/28/2020
7.0.0 1,393 6/28/2020
5.0.10 1,361 5/31/2020
5.0.9 1,461 5/30/2020
5.0.8 1,338 5/29/2020
5.0.7 1,317 5/29/2020
5.0.5 1,397 2/27/2020
5.0.4 1,364 2/26/2020
5.0.3 1,355 2/26/2020
5.0.2 1,362 2/25/2020
5.0.1 1,265 2/25/2020
5.0.0 1,385 2/25/2020
4.1.5 1,325 2/23/2020
4.1.4 1,408 2/23/2020
4.1.3 1,341 2/22/2020
4.1.2 1,335 2/22/2020
4.1.1 1,327 2/21/2020
4.1.0 1,357 2/21/2020
4.0.9 1,450 2/7/2020
4.0.8 1,289 2/7/2020
4.0.7 1,306 2/7/2020
4.0.5 1,319 1/28/2020
4.0.4 1,450 1/27/2020
4.0.3 1,303 1/27/2020
4.0.2 1,447 1/16/2020
4.0.1 1,468 1/11/2020
4.0.0 1,416 1/5/2020
3.1.7 1,467 12/17/2019
3.1.6 1,356 12/12/2019
3.1.5 1,354 12/12/2019
3.1.4 1,368 12/5/2019
3.1.3 1,400 12/4/2019
3.1.2 1,423 11/30/2019
3.1.1 1,585 11/26/2019
3.1.0 1,386 11/10/2019
3.0.4 1,229 11/1/2019
3.0.3 1,394 10/28/2019
3.0.2 1,408 10/28/2019
3.0.1 1,398 10/26/2019
3.0.0 1,226 10/23/2019
2.1.4 1,023 10/21/2019
2.1.3 1,359 10/21/2019
2.1.2 1,490 10/21/2019
2.1.1 1,367 10/19/2019
2.1.0 1,415 10/19/2019
2.0.9 1,116 10/18/2019
2.0.8 1,384 10/18/2019
2.0.7 1,121 10/18/2019
2.0.6 1,109 10/18/2019
2.0.5 1,165 10/18/2019
2.0.4 1,123 10/17/2019
2.0.3 1,257 10/16/2019
2.0.2 1,242 10/15/2019
2.0.1 1,283 10/14/2019
2.0.0 1,119 10/13/2019
1.1.7 1,452 10/11/2019
1.1.6 1,401 10/11/2019