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,458 2/17/2024
17.3.7 256 2/12/2024
17.3.6 241 2/12/2024
17.3.5 228 2/10/2024
17.3.4 207 2/9/2024
17.3.3 212 2/8/2024
17.3.2 230 2/2/2024
17.3.1 247 1/30/2024
17.2.2 225 1/30/2024
17.2.1 234 1/22/2024
17.2.0 210 1/22/2024
17.1.7 285 1/12/2024
17.1.6 244 1/11/2024
17.1.5 266 1/5/2024
17.0.1 326 1/1/2024
17.0.0 449 12/14/2023
16.11.6 315 11/14/2023
16.11.5 271 11/12/2023
16.9.0 399 10/9/2023
16.8.5 254 9/30/2023
16.8.4 253 9/25/2023
16.8.0 220 9/24/2023
16.7.51 209 9/24/2023
16.7.50 241 9/23/2023
16.7.1 295 9/4/2023
16.7.0 411 7/11/2023
16.6.13 279 7/6/2023
16.6.12 306 7/5/2023
16.6.11 298 7/5/2023
16.6.5 354 7/3/2023
16.4.4 336 7/2/2023
16.4.3 313 6/27/2023
16.4.2 338 6/25/2023
16.4.1 339 6/25/2023
16.4.0 332 6/22/2023
16.3.2 421 6/7/2023
16.3.0 454 5/28/2023
16.2.0 543 5/13/2023
16.1.10 466 5/1/2023
16.1.9 435 4/30/2023
16.1.1 438 4/20/2023
15.10.11 471 4/16/2023
15.9.40 478 4/3/2023
15.9.1 556 3/27/2023
15.9.0 556 3/24/2023
15.8.2 592 3/20/2023
15.7.0 488 3/6/2023
15.5.20 819 2/23/2023
15.5.13 643 2/13/2023
15.5.9 540 2/11/2023
15.5.2 631 2/5/2023
15.5.1 559 2/3/2023
15.5.0 600 1/28/2023
15.2.0 736 1/18/2023
15.1.0 1,257 12/28/2022
14.5.7 777 12/13/2022
14.5.5 870 12/6/2022
14.5.1 699 11/23/2022
14.5.0 646 11/18/2022
14.4.5 709 10/22/2022
14.4.2 663 10/22/2022
14.4.1 667 10/22/2022
14.4.0 693 10/17/2022
14.3.9 706 10/13/2022
14.3.6 699 10/7/2022
14.3.2 736 9/18/2022
14.3.1 810 9/12/2022
14.3.0 746 9/10/2022
14.1.3 971 8/7/2022
14.1.2 703 8/7/2022
14.1.1 747 8/7/2022
14.0.14 712 7/26/2022
14.0.12 692 7/24/2022
14.0.11 667 7/23/2022
14.0.10 701 7/23/2022
14.0.9 712 7/23/2022
14.0.8 772 7/17/2022
14.0.5 863 7/11/2022
14.0.4 752 7/7/2022
14.0.3 750 7/2/2022
14.0.2 721 7/2/2022
14.0.1 770 7/2/2022
14.0.0 753 6/25/2022
13.4.28 736 6/11/2022
13.4.25 839 6/9/2022
13.4.24 731 6/9/2022
13.4.19 791 6/8/2022
13.4.3 772 6/6/2022
13.4.2 806 6/4/2022
13.4.0 835 5/31/2022
13.3.8 782 5/19/2022
13.3.7 765 5/18/2022
13.3.6 781 5/14/2022
13.3.4 858 5/9/2022
13.3.1 797 5/1/2022
13.3.0 801 5/1/2022
13.2.2 834 4/25/2022
13.2.1 767 4/25/2022
13.2.0 802 4/21/2022
13.1.1 829 4/20/2022
13.1.0 944 4/7/2022
13.0.0 815 4/5/2022
12.0.3 1,029 3/14/2022
11.0.7 867 3/11/2022
11.0.5 950 3/2/2022
11.0.4 864 2/22/2022
11.0.3 874 2/9/2022
11.0.2 932 2/6/2022
11.0.1 891 2/5/2022
10.0.21 892 1/28/2022
10.0.20 908 1/27/2022
10.0.19 855 1/23/2022
10.0.18 826 1/17/2022
10.0.17 844 1/14/2022
10.0.16 726 1/2/2022
10.0.15 770 12/31/2021
10.0.14 780 12/28/2021
10.0.13 857 12/23/2021
10.0.11 625 12/23/2021
10.0.10 651 12/22/2021
10.0.9 801 12/22/2021
10.0.8 699 12/22/2021
10.0.7 863 12/22/2021
10.0.6 736 12/19/2021
10.0.5 845 12/18/2021
10.0.3 619 12/16/2021
10.0.2 733 12/14/2021
10.0.1 584 12/13/2021
10.0.0 638 12/6/2021
9.9.9 1,420 11/29/2021
9.9.6 4,894 11/24/2021
9.9.5 630 11/23/2021
9.9.4 954 11/21/2021
9.9.3 709 11/9/2021
9.9.2 751 11/4/2021
9.9.0 828 10/30/2021
9.8.9 859 10/29/2021
9.8.7 719 10/27/2021
9.8.6 752 10/27/2021
9.8.5 830 10/26/2021
9.8.4 807 10/25/2021
9.8.3 864 10/24/2021
9.8.1 735 10/21/2021
9.8.0 816 10/20/2021
9.7.9 711 10/20/2021
9.7.8 786 10/19/2021
9.7.7 967 10/17/2021
9.7.6 881 10/17/2021
9.7.5 760 10/14/2021
9.7.1 691 10/14/2021
9.7.0 791 10/9/2021
9.6.8 774 8/30/2021
9.6.7 746 8/26/2021
9.6.6 853 8/14/2021
9.6.5 989 8/11/2021
9.6.4 788 8/10/2021
9.6.3 743 8/9/2021
9.6.2 771 8/8/2021
9.6.1 746 8/8/2021
9.5.9 937 8/5/2021
9.5.8 939 8/4/2021
9.5.3 784 7/20/2021
9.5.0 1,172 7/9/2021
9.4.5 813 6/29/2021
9.4.4 924 6/29/2021
9.4.0 745 6/24/2021
9.3.7 771 6/21/2021
9.3.6 827 6/21/2021
9.3.5 948 6/18/2021
9.3.4 879 6/18/2021
9.2.5 953 6/7/2021
9.2.4 862 6/6/2021
9.2.3 822 6/6/2021
9.2.2 725 6/4/2021
9.2.1 958 6/1/2021
9.2.0 906 5/26/2021
9.1.9 740 5/5/2021
9.1.8 904 5/5/2021
9.1.7 766 5/3/2021
9.1.4 756 4/21/2021
9.1.2 725 4/18/2021
9.1.1 737 4/15/2021
9.1.0 746 4/14/2021
9.0.1 824 4/12/2021
9.0.0 740 4/5/2021
8.9.92 1,323 3/30/2021
8.9.4 1,315 3/26/2021
8.9.3 1,388 3/19/2021
8.9.2 1,371 1/29/2021
8.9.1 1,401 1/24/2021
8.9.0 1,508 1/22/2021
8.7.1 1,784 11/15/2020
8.7.0 1,501 11/15/2020
8.6.9 1,443 11/8/2020
8.6.7 1,428 11/4/2020
8.6.6 1,511 11/2/2020
8.6.5 1,490 11/1/2020
8.6.3 1,518 10/30/2020
8.6.2 1,376 10/30/2020
8.6.1 1,507 10/29/2020
8.6.0 1,438 10/28/2020
8.5.1 1,467 10/26/2020
8.5.0 1,407 10/23/2020
8.4.6 1,620 10/20/2020
8.4.5 1,508 10/18/2020
8.4.4 1,489 10/17/2020
8.4.3 1,488 10/16/2020
8.4.2 1,474 10/16/2020
8.4.1 1,422 10/15/2020
8.4.0 1,532 10/13/2020
8.3.3 1,436 10/11/2020
8.3.2 1,480 10/8/2020
8.3.1 1,511 10/5/2020
8.3.0 1,451 10/3/2020
8.2.3 1,429 10/1/2020
8.2.2 1,654 9/26/2020
8.2.1 1,533 9/25/2020
8.2.0 1,583 9/25/2020
8.1.25 1,483 9/24/2020
8.1.24 1,452 9/23/2020
8.1.23 1,382 9/23/2020
8.1.22 1,433 9/21/2020
8.1.21 1,515 9/15/2020
8.1.20 1,542 9/14/2020
8.1.19 1,486 9/13/2020
8.1.18 1,467 9/13/2020
8.1.17 1,528 9/13/2020
8.1.16 1,511 9/13/2020
8.1.15 1,443 9/12/2020
8.1.13 1,340 9/11/2020
8.1.12 1,488 9/11/2020
8.1.11 1,478 9/11/2020
8.1.10 1,489 9/6/2020
8.1.9 1,499 9/3/2020
8.1.8 1,527 9/2/2020
8.1.7 1,423 8/28/2020
8.1.4 1,407 8/25/2020
8.1.3 1,580 8/18/2020
8.1.2 1,365 8/16/2020
8.1.1 1,446 8/15/2020
8.0.3 1,482 8/11/2020
8.0.2 1,506 8/7/2020
8.0.1 1,487 8/7/2020
8.0.0 1,413 8/7/2020
7.0.1 1,535 6/28/2020
7.0.0 1,536 6/28/2020
5.0.10 1,523 5/31/2020
5.0.9 1,628 5/30/2020
5.0.8 1,449 5/29/2020
5.0.7 1,493 5/29/2020
5.0.5 1,553 2/27/2020
5.0.4 1,496 2/26/2020
5.0.3 1,494 2/26/2020
5.0.2 1,486 2/25/2020
5.0.1 1,415 2/25/2020
5.0.0 1,544 2/25/2020
4.1.5 1,466 2/23/2020
4.1.4 1,562 2/23/2020
4.1.3 1,475 2/22/2020
4.1.2 1,491 2/22/2020
4.1.1 1,447 2/21/2020
4.1.0 1,512 2/21/2020
4.0.9 1,589 2/7/2020
4.0.8 1,411 2/7/2020
4.0.7 1,459 2/7/2020
4.0.5 1,489 1/28/2020
4.0.4 1,577 1/27/2020
4.0.3 1,447 1/27/2020
4.0.2 1,611 1/16/2020
4.0.1 1,607 1/11/2020
4.0.0 1,552 1/5/2020
3.1.7 1,606 12/17/2019
3.1.6 1,536 12/12/2019
3.1.5 1,522 12/12/2019
3.1.4 1,494 12/5/2019
3.1.3 1,547 12/4/2019
3.1.2 1,599 11/30/2019
3.1.1 1,715 11/26/2019
3.1.0 1,541 11/10/2019
3.0.4 1,372 11/1/2019
3.0.3 1,538 10/28/2019
3.0.2 1,557 10/28/2019
3.0.1 1,561 10/26/2019
3.0.0 1,373 10/23/2019
2.1.4 1,180 10/21/2019
2.1.3 1,501 10/21/2019
2.1.2 1,643 10/21/2019
2.1.1 1,522 10/19/2019
2.1.0 1,589 10/19/2019
2.0.9 1,268 10/18/2019
2.0.8 1,548 10/18/2019
2.0.7 1,299 10/18/2019
2.0.6 1,264 10/18/2019
2.0.5 1,305 10/18/2019
2.0.4 1,265 10/17/2019
2.0.3 1,406 10/16/2019
2.0.2 1,398 10/15/2019
2.0.1 1,433 10/14/2019
2.0.0 1,285 10/13/2019
1.1.7 1,634 10/11/2019
1.1.6 1,572 10/11/2019