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. 
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. 
// Install magic.library as a Cake Addin
#addin nuget:?package=magic.library&version=17.3.9

// Install magic.library as a Cake Tool
#tool nuget:?package=magic.library&version=17.3.9

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 274 2/17/2024
17.3.7 156 2/12/2024
17.3.6 128 2/12/2024
17.3.5 118 2/10/2024
17.3.4 116 2/9/2024
17.3.3 120 2/8/2024
17.3.2 126 2/2/2024
17.3.1 133 1/30/2024
17.2.2 103 1/30/2024
17.2.1 144 1/22/2024
17.2.0 119 1/22/2024
17.1.7 189 1/12/2024
17.1.6 151 1/11/2024
17.1.5 158 1/5/2024
17.0.1 217 1/1/2024
17.0.0 344 12/14/2023
16.11.6 245 11/14/2023
16.11.5 187 11/12/2023
16.9.0 307 10/9/2023
16.8.5 189 9/30/2023
16.8.4 182 9/25/2023
16.8.0 154 9/24/2023
16.7.51 148 9/24/2023
16.7.50 158 9/23/2023
16.7.1 204 9/4/2023
16.7.0 315 7/11/2023
16.6.13 203 7/6/2023
16.6.12 200 7/5/2023
16.6.11 188 7/5/2023
16.6.5 226 7/3/2023
16.4.4 226 7/2/2023
16.4.3 235 6/27/2023
16.4.2 227 6/25/2023
16.4.1 227 6/25/2023
16.4.0 213 6/22/2023
16.3.2 304 6/7/2023
16.3.0 313 5/28/2023
16.2.0 392 5/13/2023
16.1.10 372 5/1/2023
16.1.9 291 4/30/2023
16.1.1 312 4/20/2023
15.10.11 334 4/16/2023
15.9.40 367 4/3/2023
15.9.1 424 3/27/2023
15.9.0 429 3/24/2023
15.8.2 467 3/20/2023
15.7.0 349 3/6/2023
15.5.20 718 2/23/2023
15.5.13 519 2/13/2023
15.5.9 412 2/11/2023
15.5.2 493 2/5/2023
15.5.1 407 2/3/2023
15.5.0 483 1/28/2023
15.2.0 628 1/18/2023
15.1.0 1,096 12/28/2022
14.5.7 636 12/13/2022
14.5.5 739 12/6/2022
14.5.1 573 11/23/2022
14.5.0 517 11/18/2022
14.4.5 595 10/22/2022
14.4.2 524 10/22/2022
14.4.1 528 10/22/2022
14.4.0 561 10/17/2022
14.3.9 587 10/13/2022
14.3.6 583 10/7/2022
14.3.2 592 9/18/2022
14.3.1 673 9/12/2022
14.3.0 566 9/10/2022
14.1.3 828 8/7/2022
14.1.2 578 8/7/2022
14.1.1 586 8/7/2022
14.0.14 578 7/26/2022
14.0.12 566 7/24/2022
14.0.11 544 7/23/2022
14.0.10 563 7/23/2022
14.0.9 546 7/23/2022
14.0.8 634 7/17/2022
14.0.5 702 7/11/2022
14.0.4 636 7/7/2022
14.0.3 628 7/2/2022
14.0.2 573 7/2/2022
14.0.1 618 7/2/2022
14.0.0 598 6/25/2022
13.4.28 590 6/11/2022
13.4.25 701 6/9/2022
13.4.24 592 6/9/2022
13.4.19 644 6/8/2022
13.4.3 620 6/6/2022
13.4.2 657 6/4/2022
13.4.0 677 5/31/2022
13.3.8 649 5/19/2022
13.3.7 611 5/18/2022
13.3.6 654 5/14/2022
13.3.4 727 5/9/2022
13.3.1 662 5/1/2022
13.3.0 620 5/1/2022
13.2.2 678 4/25/2022
13.2.1 635 4/25/2022
13.2.0 665 4/21/2022
13.1.1 683 4/20/2022
13.1.0 759 4/7/2022
13.0.0 694 4/5/2022
12.0.3 857 3/14/2022
11.0.7 734 3/11/2022
11.0.5 788 3/2/2022
11.0.4 709 2/22/2022
11.0.3 710 2/9/2022
11.0.2 765 2/6/2022
11.0.1 757 2/5/2022
10.0.21 723 1/28/2022
10.0.20 741 1/27/2022
10.0.19 726 1/23/2022
10.0.18 694 1/17/2022
10.0.17 705 1/14/2022
10.0.16 557 1/2/2022
10.0.15 614 12/31/2021
10.0.14 625 12/28/2021
10.0.13 695 12/23/2021
10.0.11 487 12/23/2021
10.0.10 506 12/22/2021
10.0.9 664 12/22/2021
10.0.8 553 12/22/2021
10.0.7 707 12/22/2021
10.0.6 590 12/19/2021
10.0.5 683 12/18/2021
10.0.3 469 12/16/2021
10.0.2 548 12/14/2021
10.0.1 438 12/13/2021
10.0.0 485 12/6/2021
9.9.9 1,271 11/29/2021
9.9.6 4,740 11/24/2021
9.9.5 489 11/23/2021
9.9.4 787 11/21/2021
9.9.3 558 11/9/2021
9.9.2 576 11/4/2021
9.9.0 677 10/30/2021
9.8.9 699 10/29/2021
9.8.7 583 10/27/2021
9.8.6 591 10/27/2021
9.8.5 685 10/26/2021
9.8.4 659 10/25/2021
9.8.3 711 10/24/2021
9.8.1 582 10/21/2021
9.8.0 657 10/20/2021
9.7.9 571 10/20/2021
9.7.8 603 10/19/2021
9.7.7 836 10/17/2021
9.7.6 732 10/17/2021
9.7.5 609 10/14/2021
9.7.1 547 10/14/2021
9.7.0 623 10/9/2021
9.6.8 633 8/30/2021
9.6.7 610 8/26/2021
9.6.6 722 8/14/2021
9.6.5 824 8/11/2021
9.6.4 619 8/10/2021
9.6.3 611 8/9/2021
9.6.2 610 8/8/2021
9.6.1 568 8/8/2021
9.5.9 763 8/5/2021
9.5.8 759 8/4/2021
9.5.3 644 7/20/2021
9.5.0 1,013 7/9/2021
9.4.5 621 6/29/2021
9.4.4 769 6/29/2021
9.4.0 612 6/24/2021
9.3.7 620 6/21/2021
9.3.6 672 6/21/2021
9.3.5 800 6/18/2021
9.3.4 730 6/18/2021
9.2.5 777 6/7/2021
9.2.4 717 6/6/2021
9.2.3 653 6/6/2021
9.2.2 560 6/4/2021
9.2.1 796 6/1/2021
9.2.0 755 5/26/2021
9.1.9 570 5/5/2021
9.1.8 723 5/5/2021
9.1.7 580 5/3/2021
9.1.4 587 4/21/2021
9.1.2 575 4/18/2021
9.1.1 558 4/15/2021
9.1.0 615 4/14/2021
9.0.1 681 4/12/2021
9.0.0 577 4/5/2021
8.9.92 1,152 3/30/2021
8.9.4 1,162 3/26/2021
8.9.3 1,204 3/19/2021
8.9.2 1,185 1/29/2021
8.9.1 1,252 1/24/2021
8.9.0 1,317 1/22/2021
8.7.1 1,619 11/15/2020
8.7.0 1,322 11/15/2020
8.6.9 1,260 11/8/2020
8.6.7 1,229 11/4/2020
8.6.6 1,315 11/2/2020
8.6.5 1,295 11/1/2020
8.6.3 1,319 10/30/2020
8.6.2 1,221 10/30/2020
8.6.1 1,312 10/29/2020
8.6.0 1,270 10/28/2020
8.5.1 1,260 10/26/2020
8.5.0 1,209 10/23/2020
8.4.6 1,429 10/20/2020
8.4.5 1,310 10/18/2020
8.4.4 1,333 10/17/2020
8.4.3 1,301 10/16/2020
8.4.2 1,249 10/16/2020
8.4.1 1,247 10/15/2020
8.4.0 1,326 10/13/2020
8.3.3 1,248 10/11/2020
8.3.2 1,291 10/8/2020
8.3.1 1,308 10/5/2020
8.3.0 1,266 10/3/2020
8.2.3 1,216 10/1/2020
8.2.2 1,497 9/26/2020
8.2.1 1,358 9/25/2020
8.2.0 1,391 9/25/2020
8.1.25 1,287 9/24/2020
8.1.24 1,280 9/23/2020
8.1.23 1,206 9/23/2020
8.1.22 1,279 9/21/2020
8.1.21 1,332 9/15/2020
8.1.20 1,341 9/14/2020
8.1.19 1,318 9/13/2020
8.1.18 1,286 9/13/2020
8.1.17 1,334 9/13/2020
8.1.16 1,335 9/13/2020
8.1.15 1,260 9/12/2020
8.1.13 1,155 9/11/2020
8.1.12 1,277 9/11/2020
8.1.11 1,282 9/11/2020
8.1.10 1,325 9/6/2020
8.1.9 1,323 9/3/2020
8.1.8 1,347 9/2/2020
8.1.7 1,217 8/28/2020
8.1.4 1,218 8/25/2020
8.1.3 1,391 8/18/2020
8.1.2 1,208 8/16/2020
8.1.1 1,270 8/15/2020
8.0.3 1,284 8/11/2020
8.0.2 1,304 8/7/2020
8.0.1 1,307 8/7/2020
8.0.0 1,255 8/7/2020
7.0.1 1,363 6/28/2020
7.0.0 1,357 6/28/2020
5.0.10 1,326 5/31/2020
5.0.9 1,425 5/30/2020
5.0.8 1,303 5/29/2020
5.0.7 1,276 5/29/2020
5.0.5 1,359 2/27/2020
5.0.4 1,328 2/26/2020
5.0.3 1,319 2/26/2020
5.0.2 1,325 2/25/2020
5.0.1 1,228 2/25/2020
5.0.0 1,346 2/25/2020
4.1.5 1,288 2/23/2020
4.1.4 1,370 2/23/2020
4.1.3 1,305 2/22/2020
4.1.2 1,298 2/22/2020
4.1.1 1,290 2/21/2020
4.1.0 1,321 2/21/2020
4.0.9 1,411 2/7/2020
4.0.8 1,245 2/7/2020
4.0.7 1,269 2/7/2020
4.0.5 1,281 1/28/2020
4.0.4 1,413 1/27/2020
4.0.3 1,266 1/27/2020
4.0.2 1,409 1/16/2020
4.0.1 1,431 1/11/2020
4.0.0 1,379 1/5/2020
3.1.7 1,429 12/17/2019
3.1.6 1,318 12/12/2019
3.1.5 1,316 12/12/2019
3.1.4 1,330 12/5/2019
3.1.3 1,363 12/4/2019
3.1.2 1,386 11/30/2019
3.1.1 1,547 11/26/2019
3.1.0 1,347 11/10/2019
3.0.4 1,188 11/1/2019
3.0.3 1,355 10/28/2019
3.0.2 1,369 10/28/2019
3.0.1 1,359 10/26/2019
3.0.0 1,187 10/23/2019
2.1.4 984 10/21/2019
2.1.3 1,320 10/21/2019
2.1.2 1,451 10/21/2019
2.1.1 1,328 10/19/2019
2.1.0 1,376 10/19/2019
2.0.9 1,075 10/18/2019
2.0.8 1,345 10/18/2019
2.0.7 1,081 10/18/2019
2.0.6 1,070 10/18/2019
2.0.5 1,125 10/18/2019
2.0.4 1,084 10/17/2019
2.0.3 1,217 10/16/2019
2.0.2 1,201 10/15/2019
2.0.1 1,244 10/14/2019
2.0.0 1,080 10/13/2019
1.1.7 1,413 10/11/2019
1.1.6 1,360 10/11/2019