magic.library 17.3.9

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. 
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 128 2/17/2024
17.3.7 127 2/12/2024
17.3.6 91 2/12/2024
17.3.5 88 2/10/2024
17.3.4 92 2/9/2024
17.3.3 86 2/8/2024
17.3.2 98 2/2/2024
17.3.1 102 1/30/2024
17.2.2 85 1/30/2024
17.2.1 113 1/22/2024
17.2.0 86 1/22/2024
17.1.7 156 1/12/2024
17.1.6 118 1/11/2024
17.1.5 141 1/5/2024
17.0.1 184 1/1/2024
17.0.0 318 12/14/2023
16.11.6 214 11/14/2023
16.11.5 157 11/12/2023
16.9.0 280 10/9/2023
16.8.5 163 9/30/2023
16.8.4 157 9/25/2023
16.8.0 128 9/24/2023
16.7.51 118 9/24/2023
16.7.50 126 9/23/2023
16.7.1 179 9/4/2023
16.7.0 291 7/11/2023
16.6.13 182 7/6/2023
16.6.12 177 7/5/2023
16.6.11 164 7/5/2023
16.6.5 203 7/3/2023
16.4.4 201 7/2/2023
16.4.3 219 6/27/2023
16.4.2 202 6/25/2023
16.4.1 203 6/25/2023
16.4.0 189 6/22/2023
16.3.2 282 6/7/2023
16.3.0 290 5/28/2023
16.2.0 371 5/13/2023
16.1.10 358 5/1/2023
16.1.9 275 4/30/2023
16.1.1 289 4/20/2023
15.10.11 320 4/16/2023
15.9.40 343 4/3/2023
15.9.1 393 3/27/2023
15.9.0 414 3/24/2023
15.8.2 445 3/20/2023
15.7.0 328 3/6/2023
15.5.20 686 2/23/2023
15.5.13 492 2/13/2023
15.5.9 386 2/11/2023
15.5.2 462 2/5/2023
15.5.1 384 2/3/2023
15.5.0 459 1/28/2023
15.2.0 603 1/18/2023
15.1.0 1,068 12/28/2022
14.5.7 612 12/13/2022
14.5.5 713 12/6/2022
14.5.1 547 11/23/2022
14.5.0 494 11/18/2022
14.4.5 569 10/22/2022
14.4.2 505 10/22/2022
14.4.1 501 10/22/2022
14.4.0 528 10/17/2022
14.3.9 549 10/13/2022
14.3.6 558 10/7/2022
14.3.2 565 9/18/2022
14.3.1 655 9/12/2022
14.3.0 539 9/10/2022
14.1.3 803 8/7/2022
14.1.2 548 8/7/2022
14.1.1 557 8/7/2022
14.0.14 546 7/26/2022
14.0.12 540 7/24/2022
14.0.11 520 7/23/2022
14.0.10 529 7/23/2022
14.0.9 519 7/23/2022
14.0.8 605 7/17/2022
14.0.5 675 7/11/2022
14.0.4 607 7/7/2022
14.0.3 599 7/2/2022
14.0.2 544 7/2/2022
14.0.1 589 7/2/2022
14.0.0 569 6/25/2022
13.4.28 562 6/11/2022
13.4.25 665 6/9/2022
13.4.24 563 6/9/2022
13.4.19 608 6/8/2022
13.4.3 584 6/6/2022
13.4.2 622 6/4/2022
13.4.0 649 5/31/2022
13.3.8 623 5/19/2022
13.3.7 582 5/18/2022
13.3.6 625 5/14/2022
13.3.4 693 5/9/2022
13.3.1 634 5/1/2022
13.3.0 595 5/1/2022
13.2.2 650 4/25/2022
13.2.1 607 4/25/2022
13.2.0 636 4/21/2022
13.1.1 655 4/20/2022
13.1.0 722 4/7/2022
13.0.0 666 4/5/2022
12.0.3 828 3/14/2022
11.0.7 705 3/11/2022
11.0.5 753 3/2/2022
11.0.4 681 2/22/2022
11.0.3 682 2/9/2022
11.0.2 736 2/6/2022
11.0.1 727 2/5/2022
10.0.21 695 1/28/2022
10.0.20 715 1/27/2022
10.0.19 697 1/23/2022
10.0.18 665 1/17/2022
10.0.17 678 1/14/2022
10.0.16 530 1/2/2022
10.0.15 587 12/31/2021
10.0.14 599 12/28/2021
10.0.13 669 12/23/2021
10.0.11 460 12/23/2021
10.0.10 479 12/22/2021
10.0.9 637 12/22/2021
10.0.8 518 12/22/2021
10.0.7 681 12/22/2021
10.0.6 558 12/19/2021
10.0.5 653 12/18/2021
10.0.3 443 12/16/2021
10.0.2 516 12/14/2021
10.0.1 408 12/13/2021
10.0.0 453 12/6/2021
9.9.9 1,245 11/29/2021
9.9.6 4,708 11/24/2021
9.9.5 457 11/23/2021
9.9.4 761 11/21/2021
9.9.3 524 11/9/2021
9.9.2 544 11/4/2021
9.9.0 650 10/30/2021
9.8.9 666 10/29/2021
9.8.7 559 10/27/2021
9.8.6 553 10/27/2021
9.8.5 669 10/26/2021
9.8.4 626 10/25/2021
9.8.3 685 10/24/2021
9.8.1 556 10/21/2021
9.8.0 631 10/20/2021
9.7.9 545 10/20/2021
9.7.8 578 10/19/2021
9.7.7 811 10/17/2021
9.7.6 699 10/17/2021
9.7.5 582 10/14/2021
9.7.1 520 10/14/2021
9.7.0 590 10/9/2021
9.6.8 601 8/30/2021
9.6.7 584 8/26/2021
9.6.6 687 8/14/2021
9.6.5 792 8/11/2021
9.6.4 593 8/10/2021
9.6.3 594 8/9/2021
9.6.2 567 8/8/2021
9.6.1 534 8/8/2021
9.5.9 731 8/5/2021
9.5.8 727 8/4/2021
9.5.3 611 7/20/2021
9.5.0 977 7/9/2021
9.4.5 595 6/29/2021
9.4.4 743 6/29/2021
9.4.0 578 6/24/2021
9.3.7 594 6/21/2021
9.3.6 647 6/21/2021
9.3.5 775 6/18/2021
9.3.4 705 6/18/2021
9.2.5 753 6/7/2021
9.2.4 691 6/6/2021
9.2.3 629 6/6/2021
9.2.2 536 6/4/2021
9.2.1 765 6/1/2021
9.2.0 730 5/26/2021
9.1.9 543 5/5/2021
9.1.8 691 5/5/2021
9.1.7 558 5/3/2021
9.1.4 573 4/21/2021
9.1.2 549 4/18/2021
9.1.1 535 4/15/2021
9.1.0 584 4/14/2021
9.0.1 655 4/12/2021
9.0.0 550 4/5/2021
8.9.92 1,133 3/30/2021
8.9.4 1,136 3/26/2021
8.9.3 1,171 3/19/2021
8.9.2 1,159 1/29/2021
8.9.1 1,220 1/24/2021
8.9.0 1,286 1/22/2021
8.7.1 1,592 11/15/2020
8.7.0 1,297 11/15/2020
8.6.9 1,232 11/8/2020
8.6.7 1,207 11/4/2020
8.6.6 1,299 11/2/2020
8.6.5 1,266 11/1/2020
8.6.3 1,287 10/30/2020
8.6.2 1,204 10/30/2020
8.6.1 1,286 10/29/2020
8.6.0 1,239 10/28/2020
8.5.1 1,227 10/26/2020
8.5.0 1,193 10/23/2020
8.4.6 1,402 10/20/2020
8.4.5 1,282 10/18/2020
8.4.4 1,299 10/17/2020
8.4.3 1,276 10/16/2020
8.4.2 1,223 10/16/2020
8.4.1 1,223 10/15/2020
8.4.0 1,309 10/13/2020
8.3.3 1,220 10/11/2020
8.3.2 1,275 10/8/2020
8.3.1 1,284 10/5/2020
8.3.0 1,236 10/3/2020
8.2.3 1,179 10/1/2020
8.2.2 1,473 9/26/2020
8.2.1 1,333 9/25/2020
8.2.0 1,362 9/25/2020
8.1.25 1,263 9/24/2020
8.1.24 1,264 9/23/2020
8.1.23 1,191 9/23/2020
8.1.22 1,255 9/21/2020
8.1.21 1,308 9/15/2020
8.1.20 1,316 9/14/2020
8.1.19 1,302 9/13/2020
8.1.18 1,254 9/13/2020
8.1.17 1,312 9/13/2020
8.1.16 1,301 9/13/2020
8.1.15 1,225 9/12/2020
8.1.13 1,128 9/11/2020
8.1.12 1,255 9/11/2020
8.1.11 1,252 9/11/2020
8.1.10 1,295 9/6/2020
8.1.9 1,301 9/3/2020
8.1.8 1,333 9/2/2020
8.1.7 1,192 8/28/2020
8.1.4 1,184 8/25/2020
8.1.3 1,365 8/18/2020
8.1.2 1,183 8/16/2020
8.1.1 1,243 8/15/2020
8.0.3 1,257 8/11/2020
8.0.2 1,279 8/7/2020
8.0.1 1,284 8/7/2020
8.0.0 1,230 8/7/2020
7.0.1 1,348 6/28/2020
7.0.0 1,325 6/28/2020
5.0.10 1,295 5/31/2020
5.0.9 1,386 5/30/2020
5.0.8 1,277 5/29/2020
5.0.7 1,236 5/29/2020
5.0.5 1,346 2/27/2020
5.0.4 1,303 2/26/2020
5.0.3 1,304 2/26/2020
5.0.2 1,311 2/25/2020
5.0.1 1,204 2/25/2020
5.0.0 1,321 2/25/2020
4.1.5 1,263 2/23/2020
4.1.4 1,345 2/23/2020
4.1.3 1,280 2/22/2020
4.1.2 1,273 2/22/2020
4.1.1 1,260 2/21/2020
4.1.0 1,299 2/21/2020
4.0.9 1,387 2/7/2020
4.0.8 1,220 2/7/2020
4.0.7 1,243 2/7/2020
4.0.5 1,265 1/28/2020
4.0.4 1,388 1/27/2020
4.0.3 1,240 1/27/2020
4.0.2 1,382 1/16/2020
4.0.1 1,400 1/11/2020
4.0.0 1,353 1/5/2020
3.1.7 1,397 12/17/2019
3.1.6 1,304 12/12/2019
3.1.5 1,289 12/12/2019
3.1.4 1,312 12/5/2019
3.1.3 1,336 12/4/2019
3.1.2 1,362 11/30/2019
3.1.1 1,515 11/26/2019
3.1.0 1,315 11/10/2019
3.0.4 1,157 11/1/2019
3.0.3 1,330 10/28/2019
3.0.2 1,342 10/28/2019
3.0.1 1,333 10/26/2019
3.0.0 1,156 10/23/2019
2.1.4 953 10/21/2019
2.1.3 1,288 10/21/2019
2.1.2 1,424 10/21/2019
2.1.1 1,299 10/19/2019
2.1.0 1,345 10/19/2019
2.0.9 1,049 10/18/2019
2.0.8 1,326 10/18/2019
2.0.7 1,048 10/18/2019
2.0.6 1,053 10/18/2019
2.0.5 1,087 10/18/2019
2.0.4 1,053 10/17/2019
2.0.3 1,184 10/16/2019
2.0.2 1,178 10/15/2019
2.0.1 1,218 10/14/2019
2.0.0 924 10/13/2019
1.1.7 1,377 10/11/2019
1.1.6 1,333 10/11/2019