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 914 2/17/2024
17.3.7 172 2/12/2024
17.3.6 140 2/12/2024
17.3.5 131 2/10/2024
17.3.4 128 2/9/2024
17.3.3 135 2/8/2024
17.3.2 140 2/2/2024
17.3.1 146 1/30/2024
17.2.2 116 1/30/2024
17.2.1 157 1/22/2024
17.2.0 132 1/22/2024
17.1.7 205 1/12/2024
17.1.6 164 1/11/2024
17.1.5 172 1/5/2024
17.0.1 229 1/1/2024
17.0.0 358 12/14/2023
16.11.6 251 11/14/2023
16.11.5 193 11/12/2023
16.9.0 312 10/9/2023
16.8.5 197 9/30/2023
16.8.4 187 9/25/2023
16.8.0 158 9/24/2023
16.7.51 153 9/24/2023
16.7.50 168 9/23/2023
16.7.1 212 9/4/2023
16.7.0 325 7/11/2023
16.6.13 212 7/6/2023
16.6.12 210 7/5/2023
16.6.11 198 7/5/2023
16.6.5 236 7/3/2023
16.4.4 236 7/2/2023
16.4.3 248 6/27/2023
16.4.2 237 6/25/2023
16.4.1 237 6/25/2023
16.4.0 222 6/22/2023
16.3.2 320 6/7/2023
16.3.0 334 5/28/2023
16.2.0 410 5/13/2023
16.1.10 390 5/1/2023
16.1.9 308 4/30/2023
16.1.1 331 4/20/2023
15.10.11 351 4/16/2023
15.9.40 384 4/3/2023
15.9.1 443 3/27/2023
15.9.0 447 3/24/2023
15.8.2 485 3/20/2023
15.7.0 367 3/6/2023
15.5.20 736 2/23/2023
15.5.13 538 2/13/2023
15.5.9 432 2/11/2023
15.5.2 514 2/5/2023
15.5.1 436 2/3/2023
15.5.0 502 1/28/2023
15.2.0 647 1/18/2023
15.1.0 1,117 12/28/2022
14.5.7 655 12/13/2022
14.5.5 758 12/6/2022
14.5.1 592 11/23/2022
14.5.0 539 11/18/2022
14.4.5 616 10/22/2022
14.4.2 547 10/22/2022
14.4.1 549 10/22/2022
14.4.0 581 10/17/2022
14.3.9 611 10/13/2022
14.3.6 604 10/7/2022
14.3.2 618 9/18/2022
14.3.1 695 9/12/2022
14.3.0 588 9/10/2022
14.1.3 856 8/7/2022
14.1.2 600 8/7/2022
14.1.1 613 8/7/2022
14.0.14 601 7/26/2022
14.0.12 592 7/24/2022
14.0.11 567 7/23/2022
14.0.10 587 7/23/2022
14.0.9 570 7/23/2022
14.0.8 657 7/17/2022
14.0.5 726 7/11/2022
14.0.4 661 7/7/2022
14.0.3 653 7/2/2022
14.0.2 601 7/2/2022
14.0.1 643 7/2/2022
14.0.0 623 6/25/2022
13.4.28 613 6/11/2022
13.4.25 724 6/9/2022
13.4.24 615 6/9/2022
13.4.19 669 6/8/2022
13.4.3 645 6/6/2022
13.4.2 681 6/4/2022
13.4.0 702 5/31/2022
13.3.8 681 5/19/2022
13.3.7 636 5/18/2022
13.3.6 680 5/14/2022
13.3.4 755 5/9/2022
13.3.1 689 5/1/2022
13.3.0 647 5/1/2022
13.2.2 709 4/25/2022
13.2.1 664 4/25/2022
13.2.0 698 4/21/2022
13.1.1 712 4/20/2022
13.1.0 789 4/7/2022
13.0.0 722 4/5/2022
12.0.3 885 3/14/2022
11.0.7 762 3/11/2022
11.0.5 819 3/2/2022
11.0.4 739 2/22/2022
11.0.3 742 2/9/2022
11.0.2 797 2/6/2022
11.0.1 788 2/5/2022
10.0.21 755 1/28/2022
10.0.20 773 1/27/2022
10.0.19 760 1/23/2022
10.0.18 726 1/17/2022
10.0.17 736 1/14/2022
10.0.16 590 1/2/2022
10.0.15 648 12/31/2021
10.0.14 658 12/28/2021
10.0.13 730 12/23/2021
10.0.11 518 12/23/2021
10.0.10 539 12/22/2021
10.0.9 695 12/22/2021
10.0.8 586 12/22/2021
10.0.7 739 12/22/2021
10.0.6 622 12/19/2021
10.0.5 716 12/18/2021
10.0.3 501 12/16/2021
10.0.2 580 12/14/2021
10.0.1 471 12/13/2021
10.0.0 519 12/6/2021
9.9.9 1,304 11/29/2021
9.9.6 4,773 11/24/2021
9.9.5 523 11/23/2021
9.9.4 824 11/21/2021
9.9.3 590 11/9/2021
9.9.2 609 11/4/2021
9.9.0 711 10/30/2021
9.8.9 732 10/29/2021
9.8.7 617 10/27/2021
9.8.6 625 10/27/2021
9.8.5 718 10/26/2021
9.8.4 691 10/25/2021
9.8.3 745 10/24/2021
9.8.1 615 10/21/2021
9.8.0 689 10/20/2021
9.7.9 604 10/20/2021
9.7.8 636 10/19/2021
9.7.7 871 10/17/2021
9.7.6 767 10/17/2021
9.7.5 642 10/14/2021
9.7.1 580 10/14/2021
9.7.0 656 10/9/2021
9.6.8 666 8/30/2021
9.6.7 644 8/26/2021
9.6.6 755 8/14/2021
9.6.5 859 8/11/2021
9.6.4 652 8/10/2021
9.6.3 650 8/9/2021
9.6.2 642 8/8/2021
9.6.1 600 8/8/2021
9.5.9 798 8/5/2021
9.5.8 793 8/4/2021
9.5.3 678 7/20/2021
9.5.0 1,045 7/9/2021
9.4.5 654 6/29/2021
9.4.4 800 6/29/2021
9.4.0 645 6/24/2021
9.3.7 652 6/21/2021
9.3.6 705 6/21/2021
9.3.5 831 6/18/2021
9.3.4 761 6/18/2021
9.2.5 812 6/7/2021
9.2.4 750 6/6/2021
9.2.3 687 6/6/2021
9.2.2 595 6/4/2021
9.2.1 831 6/1/2021
9.2.0 788 5/26/2021
9.1.9 607 5/5/2021
9.1.8 760 5/5/2021
9.1.7 618 5/3/2021
9.1.4 625 4/21/2021
9.1.2 611 4/18/2021
9.1.1 598 4/15/2021
9.1.0 653 4/14/2021
9.0.1 718 4/12/2021
9.0.0 615 4/5/2021
8.9.92 1,189 3/30/2021
8.9.4 1,200 3/26/2021
8.9.3 1,243 3/19/2021
8.9.2 1,229 1/29/2021
8.9.1 1,295 1/24/2021
8.9.0 1,359 1/22/2021
8.7.1 1,661 11/15/2020
8.7.0 1,364 11/15/2020
8.6.9 1,302 11/8/2020
8.6.7 1,272 11/4/2020
8.6.6 1,359 11/2/2020
8.6.5 1,339 11/1/2020
8.6.3 1,361 10/30/2020
8.6.2 1,264 10/30/2020
8.6.1 1,352 10/29/2020
8.6.0 1,313 10/28/2020
8.5.1 1,302 10/26/2020
8.5.0 1,254 10/23/2020
8.4.6 1,470 10/20/2020
8.4.5 1,354 10/18/2020
8.4.4 1,375 10/17/2020
8.4.3 1,344 10/16/2020
8.4.2 1,290 10/16/2020
8.4.1 1,289 10/15/2020
8.4.0 1,368 10/13/2020
8.3.3 1,290 10/11/2020
8.3.2 1,334 10/8/2020
8.3.1 1,349 10/5/2020
8.3.0 1,313 10/3/2020
8.2.3 1,259 10/1/2020
8.2.2 1,539 9/26/2020
8.2.1 1,399 9/25/2020
8.2.0 1,432 9/25/2020
8.1.25 1,329 9/24/2020
8.1.24 1,321 9/23/2020
8.1.23 1,255 9/23/2020
8.1.22 1,321 9/21/2020
8.1.21 1,380 9/15/2020
8.1.20 1,386 9/14/2020
8.1.19 1,359 9/13/2020
8.1.18 1,327 9/13/2020
8.1.17 1,377 9/13/2020
8.1.16 1,376 9/13/2020
8.1.15 1,301 9/12/2020
8.1.13 1,197 9/11/2020
8.1.12 1,321 9/11/2020
8.1.11 1,324 9/11/2020
8.1.10 1,366 9/6/2020
8.1.9 1,364 9/3/2020
8.1.8 1,390 9/2/2020
8.1.7 1,259 8/28/2020
8.1.4 1,261 8/25/2020
8.1.3 1,438 8/18/2020
8.1.2 1,251 8/16/2020
8.1.1 1,311 8/15/2020
8.0.3 1,326 8/11/2020
8.0.2 1,347 8/7/2020
8.0.1 1,348 8/7/2020
8.0.0 1,297 8/7/2020
7.0.1 1,406 6/28/2020
7.0.0 1,400 6/28/2020
5.0.10 1,368 5/31/2020
5.0.9 1,468 5/30/2020
5.0.8 1,345 5/29/2020
5.0.7 1,324 5/29/2020
5.0.5 1,404 2/27/2020
5.0.4 1,371 2/26/2020
5.0.3 1,362 2/26/2020
5.0.2 1,369 2/25/2020
5.0.1 1,272 2/25/2020
5.0.0 1,392 2/25/2020
4.1.5 1,334 2/23/2020
4.1.4 1,415 2/23/2020
4.1.3 1,348 2/22/2020
4.1.2 1,342 2/22/2020
4.1.1 1,334 2/21/2020
4.1.0 1,364 2/21/2020
4.0.9 1,456 2/7/2020
4.0.8 1,295 2/7/2020
4.0.7 1,312 2/7/2020
4.0.5 1,325 1/28/2020
4.0.4 1,458 1/27/2020
4.0.3 1,309 1/27/2020
4.0.2 1,453 1/16/2020
4.0.1 1,474 1/11/2020
4.0.0 1,422 1/5/2020
3.1.7 1,473 12/17/2019
3.1.6 1,362 12/12/2019
3.1.5 1,360 12/12/2019
3.1.4 1,374 12/5/2019
3.1.3 1,406 12/4/2019
3.1.2 1,429 11/30/2019
3.1.1 1,591 11/26/2019
3.1.0 1,392 11/10/2019
3.0.4 1,236 11/1/2019
3.0.3 1,400 10/28/2019
3.0.2 1,414 10/28/2019
3.0.1 1,404 10/26/2019
3.0.0 1,232 10/23/2019
2.1.4 1,029 10/21/2019
2.1.3 1,365 10/21/2019
2.1.2 1,496 10/21/2019
2.1.1 1,373 10/19/2019
2.1.0 1,422 10/19/2019
2.0.9 1,122 10/18/2019
2.0.8 1,390 10/18/2019
2.0.7 1,127 10/18/2019
2.0.6 1,115 10/18/2019
2.0.5 1,171 10/18/2019
2.0.4 1,129 10/17/2019
2.0.3 1,263 10/16/2019
2.0.2 1,248 10/15/2019
2.0.1 1,290 10/14/2019
2.0.0 1,125 10/13/2019
1.1.7 1,459 10/11/2019
1.1.6 1,408 10/11/2019