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. 
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 135 2/2/2024
17.3.1 142 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 159 1/11/2024
17.1.5 168 1/5/2024
17.0.1 226 1/1/2024
17.0.0 352 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 206 9/4/2023
16.7.0 319 7/11/2023
16.6.13 206 7/6/2023
16.6.12 203 7/5/2023
16.6.11 192 7/5/2023
16.6.5 229 7/3/2023
16.4.4 229 7/2/2023
16.4.3 242 6/27/2023
16.4.2 231 6/25/2023
16.4.1 231 6/25/2023
16.4.0 216 6/22/2023
16.3.2 313 6/7/2023
16.3.0 327 5/28/2023
16.2.0 401 5/13/2023
16.1.10 382 5/1/2023
16.1.9 301 4/30/2023
16.1.1 322 4/20/2023
15.10.11 344 4/16/2023
15.9.40 377 4/3/2023
15.9.1 435 3/27/2023
15.9.0 439 3/24/2023
15.8.2 478 3/20/2023
15.7.0 360 3/6/2023
15.5.20 728 2/23/2023
15.5.13 530 2/13/2023
15.5.9 424 2/11/2023
15.5.2 506 2/5/2023
15.5.1 427 2/3/2023
15.5.0 495 1/28/2023
15.2.0 640 1/18/2023
15.1.0 1,110 12/28/2022
14.5.7 648 12/13/2022
14.5.5 751 12/6/2022
14.5.1 585 11/23/2022
14.5.0 531 11/18/2022
14.4.5 609 10/22/2022
14.4.2 539 10/22/2022
14.4.1 541 10/22/2022
14.4.0 574 10/17/2022
14.3.9 604 10/13/2022
14.3.6 596 10/7/2022
14.3.2 611 9/18/2022
14.3.1 688 9/12/2022
14.3.0 581 9/10/2022
14.1.3 848 8/7/2022
14.1.2 592 8/7/2022
14.1.1 601 8/7/2022
14.0.14 593 7/26/2022
14.0.12 583 7/24/2022
14.0.11 559 7/23/2022
14.0.10 579 7/23/2022
14.0.9 561 7/23/2022
14.0.8 649 7/17/2022
14.0.5 718 7/11/2022
14.0.4 653 7/7/2022
14.0.3 645 7/2/2022
14.0.2 593 7/2/2022
14.0.1 635 7/2/2022
14.0.0 613 6/25/2022
13.4.28 605 6/11/2022
13.4.25 716 6/9/2022
13.4.24 607 6/9/2022
13.4.19 661 6/8/2022
13.4.3 636 6/6/2022
13.4.2 672 6/4/2022
13.4.0 693 5/31/2022
13.3.8 672 5/19/2022
13.3.7 628 5/18/2022
13.3.6 672 5/14/2022
13.3.4 746 5/9/2022
13.3.1 679 5/1/2022
13.3.0 637 5/1/2022
13.2.2 698 4/25/2022
13.2.1 655 4/25/2022
13.2.0 689 4/21/2022
13.1.1 702 4/20/2022
13.1.0 778 4/7/2022
13.0.0 712 4/5/2022
12.0.3 875 3/14/2022
11.0.7 752 3/11/2022
11.0.5 809 3/2/2022
11.0.4 729 2/22/2022
11.0.3 731 2/9/2022
11.0.2 787 2/6/2022
11.0.1 778 2/5/2022
10.0.21 745 1/28/2022
10.0.20 762 1/27/2022
10.0.19 749 1/23/2022
10.0.18 715 1/17/2022
10.0.17 726 1/14/2022
10.0.16 579 1/2/2022
10.0.15 637 12/31/2021
10.0.14 648 12/28/2021
10.0.13 719 12/23/2021
10.0.11 508 12/23/2021
10.0.10 528 12/22/2021
10.0.9 685 12/22/2021
10.0.8 575 12/22/2021
10.0.7 728 12/22/2021
10.0.6 612 12/19/2021
10.0.5 706 12/18/2021
10.0.3 490 12/16/2021
10.0.2 570 12/14/2021
10.0.1 460 12/13/2021
10.0.0 507 12/6/2021
9.9.9 1,294 11/29/2021
9.9.6 4,762 11/24/2021
9.9.5 513 11/23/2021
9.9.4 814 11/21/2021
9.9.3 580 11/9/2021
9.9.2 599 11/4/2021
9.9.0 700 10/30/2021
9.8.9 722 10/29/2021
9.8.7 607 10/27/2021
9.8.6 615 10/27/2021
9.8.5 708 10/26/2021
9.8.4 681 10/25/2021
9.8.3 735 10/24/2021
9.8.1 604 10/21/2021
9.8.0 679 10/20/2021
9.7.9 594 10/20/2021
9.7.8 626 10/19/2021
9.7.7 861 10/17/2021
9.7.6 756 10/17/2021
9.7.5 632 10/14/2021
9.7.1 570 10/14/2021
9.7.0 645 10/9/2021
9.6.8 660 8/30/2021
9.6.7 638 8/26/2021
9.6.6 749 8/14/2021
9.6.5 853 8/11/2021
9.6.4 646 8/10/2021
9.6.3 644 8/9/2021
9.6.2 636 8/8/2021
9.6.1 594 8/8/2021
9.5.9 791 8/5/2021
9.5.8 786 8/4/2021
9.5.3 671 7/20/2021
9.5.0 1,038 7/9/2021
9.4.5 648 6/29/2021
9.4.4 794 6/29/2021
9.4.0 639 6/24/2021
9.3.7 646 6/21/2021
9.3.6 699 6/21/2021
9.3.5 825 6/18/2021
9.3.4 755 6/18/2021
9.2.5 805 6/7/2021
9.2.4 743 6/6/2021
9.2.3 680 6/6/2021
9.2.2 587 6/4/2021
9.2.1 823 6/1/2021
9.2.0 780 5/26/2021
9.1.9 599 5/5/2021
9.1.8 752 5/5/2021
9.1.7 610 5/3/2021
9.1.4 617 4/21/2021
9.1.2 603 4/18/2021
9.1.1 589 4/15/2021
9.1.0 644 4/14/2021
9.0.1 710 4/12/2021
9.0.0 607 4/5/2021
8.9.92 1,181 3/30/2021
8.9.4 1,192 3/26/2021
8.9.3 1,234 3/19/2021
8.9.2 1,218 1/29/2021
8.9.1 1,285 1/24/2021
8.9.0 1,350 1/22/2021
8.7.1 1,651 11/15/2020
8.7.0 1,355 11/15/2020
8.6.9 1,293 11/8/2020
8.6.7 1,263 11/4/2020
8.6.6 1,350 11/2/2020
8.6.5 1,330 11/1/2020
8.6.3 1,352 10/30/2020
8.6.2 1,255 10/30/2020
8.6.1 1,343 10/29/2020
8.6.0 1,304 10/28/2020
8.5.1 1,293 10/26/2020
8.5.0 1,243 10/23/2020
8.4.6 1,461 10/20/2020
8.4.5 1,345 10/18/2020
8.4.4 1,366 10/17/2020
8.4.3 1,335 10/16/2020
8.4.2 1,281 10/16/2020
8.4.1 1,280 10/15/2020
8.4.0 1,359 10/13/2020
8.3.3 1,281 10/11/2020
8.3.2 1,325 10/8/2020
8.3.1 1,340 10/5/2020
8.3.0 1,304 10/3/2020
8.2.3 1,250 10/1/2020
8.2.2 1,530 9/26/2020
8.2.1 1,390 9/25/2020
8.2.0 1,423 9/25/2020
8.1.25 1,320 9/24/2020
8.1.24 1,312 9/23/2020
8.1.23 1,240 9/23/2020
8.1.22 1,312 9/21/2020
8.1.21 1,365 9/15/2020
8.1.20 1,377 9/14/2020
8.1.19 1,350 9/13/2020
8.1.18 1,318 9/13/2020
8.1.17 1,368 9/13/2020
8.1.16 1,367 9/13/2020
8.1.15 1,292 9/12/2020
8.1.13 1,187 9/11/2020
8.1.12 1,312 9/11/2020
8.1.11 1,314 9/11/2020
8.1.10 1,357 9/6/2020
8.1.9 1,355 9/3/2020
8.1.8 1,381 9/2/2020
8.1.7 1,249 8/28/2020
8.1.4 1,251 8/25/2020
8.1.3 1,429 8/18/2020
8.1.2 1,242 8/16/2020
8.1.1 1,302 8/15/2020
8.0.3 1,317 8/11/2020
8.0.2 1,338 8/7/2020
8.0.1 1,339 8/7/2020
8.0.0 1,287 8/7/2020
7.0.1 1,397 6/28/2020
7.0.0 1,391 6/28/2020
5.0.10 1,359 5/31/2020
5.0.9 1,459 5/30/2020
5.0.8 1,336 5/29/2020
5.0.7 1,314 5/29/2020
5.0.5 1,395 2/27/2020
5.0.4 1,362 2/26/2020
5.0.3 1,353 2/26/2020
5.0.2 1,360 2/25/2020
5.0.1 1,263 2/25/2020
5.0.0 1,383 2/25/2020
4.1.5 1,323 2/23/2020
4.1.4 1,406 2/23/2020
4.1.3 1,339 2/22/2020
4.1.2 1,333 2/22/2020
4.1.1 1,325 2/21/2020
4.1.0 1,355 2/21/2020
4.0.9 1,446 2/7/2020
4.0.8 1,286 2/7/2020
4.0.7 1,303 2/7/2020
4.0.5 1,316 1/28/2020
4.0.4 1,448 1/27/2020
4.0.3 1,300 1/27/2020
4.0.2 1,444 1/16/2020
4.0.1 1,465 1/11/2020
4.0.0 1,413 1/5/2020
3.1.7 1,463 12/17/2019
3.1.6 1,353 12/12/2019
3.1.5 1,351 12/12/2019
3.1.4 1,365 12/5/2019
3.1.3 1,397 12/4/2019
3.1.2 1,420 11/30/2019
3.1.1 1,582 11/26/2019
3.1.0 1,383 11/10/2019
3.0.4 1,226 11/1/2019
3.0.3 1,391 10/28/2019
3.0.2 1,405 10/28/2019
3.0.1 1,395 10/26/2019
3.0.0 1,223 10/23/2019
2.1.4 1,020 10/21/2019
2.1.3 1,356 10/21/2019
2.1.2 1,487 10/21/2019
2.1.1 1,364 10/19/2019
2.1.0 1,412 10/19/2019
2.0.9 1,112 10/18/2019
2.0.8 1,381 10/18/2019
2.0.7 1,118 10/18/2019
2.0.6 1,106 10/18/2019
2.0.5 1,162 10/18/2019
2.0.4 1,120 10/17/2019
2.0.3 1,254 10/16/2019
2.0.2 1,239 10/15/2019
2.0.1 1,280 10/14/2019
2.0.0 1,116 10/13/2019
1.1.7 1,449 10/11/2019
1.1.6 1,398 10/11/2019