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,466 2/17/2024
17.3.7 261 2/12/2024
17.3.6 245 2/12/2024
17.3.5 235 2/10/2024
17.3.4 212 2/9/2024
17.3.3 222 2/8/2024
17.3.2 236 2/2/2024
17.3.1 253 1/30/2024
17.2.2 233 1/30/2024
17.2.1 241 1/22/2024
17.2.0 216 1/22/2024
17.1.7 291 1/12/2024
17.1.6 254 1/11/2024
17.1.5 272 1/5/2024
17.0.1 335 1/1/2024
17.0.0 457 12/14/2023
16.11.6 321 11/14/2023
16.11.5 279 11/12/2023
16.9.0 405 10/9/2023
16.8.5 262 9/30/2023
16.8.4 259 9/25/2023
16.8.0 227 9/24/2023
16.7.51 211 9/24/2023
16.7.50 246 9/23/2023
16.7.1 303 9/4/2023
16.7.0 418 7/11/2023
16.6.13 287 7/6/2023
16.6.12 310 7/5/2023
16.6.11 303 7/5/2023
16.6.5 362 7/3/2023
16.4.4 340 7/2/2023
16.4.3 317 6/27/2023
16.4.2 343 6/25/2023
16.4.1 344 6/25/2023
16.4.0 336 6/22/2023
16.3.2 424 6/7/2023
16.3.0 456 5/28/2023
16.2.0 548 5/13/2023
16.1.10 471 5/1/2023
16.1.9 440 4/30/2023
16.1.1 444 4/20/2023
15.10.11 480 4/16/2023
15.9.40 482 4/3/2023
15.9.1 561 3/27/2023
15.9.0 562 3/24/2023
15.8.2 599 3/20/2023
15.7.0 494 3/6/2023
15.5.20 824 2/23/2023
15.5.13 649 2/13/2023
15.5.9 544 2/11/2023
15.5.2 636 2/5/2023
15.5.1 564 2/3/2023
15.5.0 608 1/28/2023
15.2.0 742 1/18/2023
15.1.0 1,258 12/28/2022
14.5.7 784 12/13/2022
14.5.5 878 12/6/2022
14.5.1 704 11/23/2022
14.5.0 653 11/18/2022
14.4.5 716 10/22/2022
14.4.2 673 10/22/2022
14.4.1 672 10/22/2022
14.4.0 702 10/17/2022
14.3.9 712 10/13/2022
14.3.6 707 10/7/2022
14.3.2 743 9/18/2022
14.3.1 817 9/12/2022
14.3.0 756 9/10/2022
14.1.3 980 8/7/2022
14.1.2 713 8/7/2022
14.1.1 753 8/7/2022
14.0.14 721 7/26/2022
14.0.12 702 7/24/2022
14.0.11 675 7/23/2022
14.0.10 707 7/23/2022
14.0.9 721 7/23/2022
14.0.8 781 7/17/2022
14.0.5 871 7/11/2022
14.0.4 763 7/7/2022
14.0.3 757 7/2/2022
14.0.2 729 7/2/2022
14.0.1 775 7/2/2022
14.0.0 760 6/25/2022
13.4.28 743 6/11/2022
13.4.25 846 6/9/2022
13.4.24 745 6/9/2022
13.4.19 798 6/8/2022
13.4.3 781 6/6/2022
13.4.2 814 6/4/2022
13.4.0 845 5/31/2022
13.3.8 787 5/19/2022
13.3.7 774 5/18/2022
13.3.6 792 5/14/2022
13.3.4 867 5/9/2022
13.3.1 808 5/1/2022
13.3.0 807 5/1/2022
13.2.2 845 4/25/2022
13.2.1 778 4/25/2022
13.2.0 807 4/21/2022
13.1.1 838 4/20/2022
13.1.0 955 4/7/2022
13.0.0 821 4/5/2022
12.0.3 1,035 3/14/2022
11.0.7 875 3/11/2022
11.0.5 957 3/2/2022
11.0.4 870 2/22/2022
11.0.3 884 2/9/2022
11.0.2 939 2/6/2022
11.0.1 896 2/5/2022
10.0.21 899 1/28/2022
10.0.20 916 1/27/2022
10.0.19 865 1/23/2022
10.0.18 831 1/17/2022
10.0.17 850 1/14/2022
10.0.16 732 1/2/2022
10.0.15 779 12/31/2021
10.0.14 787 12/28/2021
10.0.13 863 12/23/2021
10.0.11 637 12/23/2021
10.0.10 657 12/22/2021
10.0.9 808 12/22/2021
10.0.8 706 12/22/2021
10.0.7 871 12/22/2021
10.0.6 743 12/19/2021
10.0.5 852 12/18/2021
10.0.3 624 12/16/2021
10.0.2 741 12/14/2021
10.0.1 590 12/13/2021
10.0.0 645 12/6/2021
9.9.9 1,429 11/29/2021
9.9.6 4,904 11/24/2021
9.9.5 637 11/23/2021
9.9.4 961 11/21/2021
9.9.3 717 11/9/2021
9.9.2 760 11/4/2021
9.9.0 839 10/30/2021
9.8.9 869 10/29/2021
9.8.7 724 10/27/2021
9.8.6 759 10/27/2021
9.8.5 838 10/26/2021
9.8.4 815 10/25/2021
9.8.3 870 10/24/2021
9.8.1 740 10/21/2021
9.8.0 823 10/20/2021
9.7.9 717 10/20/2021
9.7.8 796 10/19/2021
9.7.7 976 10/17/2021
9.7.6 890 10/17/2021
9.7.5 767 10/14/2021
9.7.1 699 10/14/2021
9.7.0 797 10/9/2021
9.6.8 780 8/30/2021
9.6.7 751 8/26/2021
9.6.6 862 8/14/2021
9.6.5 997 8/11/2021
9.6.4 797 8/10/2021
9.6.3 751 8/9/2021
9.6.2 778 8/8/2021
9.6.1 752 8/8/2021
9.5.9 943 8/5/2021
9.5.8 950 8/4/2021
9.5.3 791 7/20/2021
9.5.0 1,184 7/9/2021
9.4.5 822 6/29/2021
9.4.4 929 6/29/2021
9.4.0 753 6/24/2021
9.3.7 780 6/21/2021
9.3.6 835 6/21/2021
9.3.5 958 6/18/2021
9.3.4 885 6/18/2021
9.2.5 959 6/7/2021
9.2.4 872 6/6/2021
9.2.3 829 6/6/2021
9.2.2 733 6/4/2021
9.2.1 965 6/1/2021
9.2.0 913 5/26/2021
9.1.9 749 5/5/2021
9.1.8 908 5/5/2021
9.1.7 780 5/3/2021
9.1.4 765 4/21/2021
9.1.2 733 4/18/2021
9.1.1 743 4/15/2021
9.1.0 755 4/14/2021
9.0.1 833 4/12/2021
9.0.0 751 4/5/2021
8.9.92 1,331 3/30/2021
8.9.4 1,324 3/26/2021
8.9.3 1,395 3/19/2021
8.9.2 1,378 1/29/2021
8.9.1 1,410 1/24/2021
8.9.0 1,517 1/22/2021
8.7.1 1,798 11/15/2020
8.7.0 1,513 11/15/2020
8.6.9 1,451 11/8/2020
8.6.7 1,441 11/4/2020
8.6.6 1,522 11/2/2020
8.6.5 1,499 11/1/2020
8.6.3 1,529 10/30/2020
8.6.2 1,381 10/30/2020
8.6.1 1,517 10/29/2020
8.6.0 1,447 10/28/2020
8.5.1 1,474 10/26/2020
8.5.0 1,417 10/23/2020
8.4.6 1,627 10/20/2020
8.4.5 1,518 10/18/2020
8.4.4 1,496 10/17/2020
8.4.3 1,495 10/16/2020
8.4.2 1,480 10/16/2020
8.4.1 1,430 10/15/2020
8.4.0 1,541 10/13/2020
8.3.3 1,442 10/11/2020
8.3.2 1,485 10/8/2020
8.3.1 1,518 10/5/2020
8.3.0 1,458 10/3/2020
8.2.3 1,437 10/1/2020
8.2.2 1,666 9/26/2020
8.2.1 1,545 9/25/2020
8.2.0 1,597 9/25/2020
8.1.25 1,491 9/24/2020
8.1.24 1,466 9/23/2020
8.1.23 1,394 9/23/2020
8.1.22 1,444 9/21/2020
8.1.21 1,523 9/15/2020
8.1.20 1,550 9/14/2020
8.1.19 1,496 9/13/2020
8.1.18 1,478 9/13/2020
8.1.17 1,536 9/13/2020
8.1.16 1,521 9/13/2020
8.1.15 1,451 9/12/2020
8.1.13 1,351 9/11/2020
8.1.12 1,493 9/11/2020
8.1.11 1,490 9/11/2020
8.1.10 1,494 9/6/2020
8.1.9 1,508 9/3/2020
8.1.8 1,536 9/2/2020
8.1.7 1,428 8/28/2020
8.1.4 1,415 8/25/2020
8.1.3 1,587 8/18/2020
8.1.2 1,376 8/16/2020
8.1.1 1,456 8/15/2020
8.0.3 1,491 8/11/2020
8.0.2 1,515 8/7/2020
8.0.1 1,496 8/7/2020
8.0.0 1,420 8/7/2020
7.0.1 1,541 6/28/2020
7.0.0 1,545 6/28/2020
5.0.10 1,530 5/31/2020
5.0.9 1,643 5/30/2020
5.0.8 1,458 5/29/2020
5.0.7 1,503 5/29/2020
5.0.5 1,562 2/27/2020
5.0.4 1,505 2/26/2020
5.0.3 1,502 2/26/2020
5.0.2 1,495 2/25/2020
5.0.1 1,424 2/25/2020
5.0.0 1,554 2/25/2020
4.1.5 1,475 2/23/2020
4.1.4 1,570 2/23/2020
4.1.3 1,485 2/22/2020
4.1.2 1,499 2/22/2020
4.1.1 1,456 2/21/2020
4.1.0 1,523 2/21/2020
4.0.9 1,595 2/7/2020
4.0.8 1,421 2/7/2020
4.0.7 1,470 2/7/2020
4.0.5 1,497 1/28/2020
4.0.4 1,584 1/27/2020
4.0.3 1,455 1/27/2020
4.0.2 1,618 1/16/2020
4.0.1 1,613 1/11/2020
4.0.0 1,564 1/5/2020
3.1.7 1,618 12/17/2019
3.1.6 1,547 12/12/2019
3.1.5 1,530 12/12/2019
3.1.4 1,503 12/5/2019
3.1.3 1,559 12/4/2019
3.1.2 1,611 11/30/2019
3.1.1 1,723 11/26/2019
3.1.0 1,552 11/10/2019
3.0.4 1,382 11/1/2019
3.0.3 1,546 10/28/2019
3.0.2 1,566 10/28/2019
3.0.1 1,566 10/26/2019
3.0.0 1,381 10/23/2019
2.1.4 1,189 10/21/2019
2.1.3 1,512 10/21/2019
2.1.2 1,653 10/21/2019
2.1.1 1,532 10/19/2019
2.1.0 1,595 10/19/2019
2.0.9 1,282 10/18/2019
2.0.8 1,560 10/18/2019
2.0.7 1,309 10/18/2019
2.0.6 1,270 10/18/2019
2.0.5 1,316 10/18/2019
2.0.4 1,278 10/17/2019
2.0.3 1,416 10/16/2019
2.0.2 1,410 10/15/2019
2.0.1 1,443 10/14/2019
2.0.0 1,291 10/13/2019
1.1.7 1,641 10/11/2019
1.1.6 1,579 10/11/2019