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 284 2/17/2024
17.3.7 159 2/12/2024
17.3.6 128 2/12/2024
17.3.5 118 2/10/2024
17.3.4 117 2/9/2024
17.3.3 123 2/8/2024
17.3.2 126 2/2/2024
17.3.1 134 1/30/2024
17.2.2 105 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 159 1/5/2024
17.0.1 217 1/1/2024
17.0.0 344 12/14/2023
16.11.6 246 11/14/2023
16.11.5 189 11/12/2023
16.9.0 307 10/9/2023
16.8.5 189 9/30/2023
16.8.4 183 9/25/2023
16.8.0 154 9/24/2023
16.7.51 149 9/24/2023
16.7.50 158 9/23/2023
16.7.1 205 9/4/2023
16.7.0 316 7/11/2023
16.6.13 204 7/6/2023
16.6.12 201 7/5/2023
16.6.11 189 7/5/2023
16.6.5 227 7/3/2023
16.4.4 227 7/2/2023
16.4.3 239 6/27/2023
16.4.2 228 6/25/2023
16.4.1 228 6/25/2023
16.4.0 214 6/22/2023
16.3.2 308 6/7/2023
16.3.0 317 5/28/2023
16.2.0 397 5/13/2023
16.1.10 377 5/1/2023
16.1.9 296 4/30/2023
16.1.1 317 4/20/2023
15.10.11 339 4/16/2023
15.9.40 372 4/3/2023
15.9.1 429 3/27/2023
15.9.0 434 3/24/2023
15.8.2 473 3/20/2023
15.7.0 355 3/6/2023
15.5.20 724 2/23/2023
15.5.13 525 2/13/2023
15.5.9 418 2/11/2023
15.5.2 501 2/5/2023
15.5.1 415 2/3/2023
15.5.0 489 1/28/2023
15.2.0 634 1/18/2023
15.1.0 1,105 12/28/2022
14.5.7 643 12/13/2022
14.5.5 746 12/6/2022
14.5.1 580 11/23/2022
14.5.0 525 11/18/2022
14.4.5 602 10/22/2022
14.4.2 531 10/22/2022
14.4.1 535 10/22/2022
14.4.0 568 10/17/2022
14.3.9 598 10/13/2022
14.3.6 590 10/7/2022
14.3.2 600 9/18/2022
14.3.1 681 9/12/2022
14.3.0 574 9/10/2022
14.1.3 836 8/7/2022
14.1.2 586 8/7/2022
14.1.1 594 8/7/2022
14.0.14 586 7/26/2022
14.0.12 575 7/24/2022
14.0.11 552 7/23/2022
14.0.10 571 7/23/2022
14.0.9 554 7/23/2022
14.0.8 642 7/17/2022
14.0.5 710 7/11/2022
14.0.4 645 7/7/2022
14.0.3 636 7/2/2022
14.0.2 581 7/2/2022
14.0.1 626 7/2/2022
14.0.0 606 6/25/2022
13.4.28 598 6/11/2022
13.4.25 709 6/9/2022
13.4.24 600 6/9/2022
13.4.19 652 6/8/2022
13.4.3 628 6/6/2022
13.4.2 665 6/4/2022
13.4.0 685 5/31/2022
13.3.8 659 5/19/2022
13.3.7 619 5/18/2022
13.3.6 662 5/14/2022
13.3.4 737 5/9/2022
13.3.1 670 5/1/2022
13.3.0 629 5/1/2022
13.2.2 687 4/25/2022
13.2.1 644 4/25/2022
13.2.0 679 4/21/2022
13.1.1 692 4/20/2022
13.1.0 768 4/7/2022
13.0.0 703 4/5/2022
12.0.3 866 3/14/2022
11.0.7 743 3/11/2022
11.0.5 799 3/2/2022
11.0.4 719 2/22/2022
11.0.3 720 2/9/2022
11.0.2 775 2/6/2022
11.0.1 767 2/5/2022
10.0.21 733 1/28/2022
10.0.20 751 1/27/2022
10.0.19 737 1/23/2022
10.0.18 704 1/17/2022
10.0.17 715 1/14/2022
10.0.16 567 1/2/2022
10.0.15 626 12/31/2021
10.0.14 637 12/28/2021
10.0.13 707 12/23/2021
10.0.11 497 12/23/2021
10.0.10 516 12/22/2021
10.0.9 674 12/22/2021
10.0.8 563 12/22/2021
10.0.7 717 12/22/2021
10.0.6 600 12/19/2021
10.0.5 694 12/18/2021
10.0.3 479 12/16/2021
10.0.2 558 12/14/2021
10.0.1 449 12/13/2021
10.0.0 495 12/6/2021
9.9.9 1,282 11/29/2021
9.9.6 4,750 11/24/2021
9.9.5 500 11/23/2021
9.9.4 799 11/21/2021
9.9.3 568 11/9/2021
9.9.2 586 11/4/2021
9.9.0 687 10/30/2021
9.8.9 709 10/29/2021
9.8.7 595 10/27/2021
9.8.6 602 10/27/2021
9.8.5 696 10/26/2021
9.8.4 669 10/25/2021
9.8.3 721 10/24/2021
9.8.1 592 10/21/2021
9.8.0 667 10/20/2021
9.7.9 581 10/20/2021
9.7.8 613 10/19/2021
9.7.7 848 10/17/2021
9.7.6 744 10/17/2021
9.7.5 619 10/14/2021
9.7.1 557 10/14/2021
9.7.0 633 10/9/2021
9.6.8 643 8/30/2021
9.6.7 620 8/26/2021
9.6.6 732 8/14/2021
9.6.5 835 8/11/2021
9.6.4 630 8/10/2021
9.6.3 626 8/9/2021
9.6.2 619 8/8/2021
9.6.1 577 8/8/2021
9.5.9 774 8/5/2021
9.5.8 770 8/4/2021
9.5.3 655 7/20/2021
9.5.0 1,022 7/9/2021
9.4.5 630 6/29/2021
9.4.4 778 6/29/2021
9.4.0 622 6/24/2021
9.3.7 629 6/21/2021
9.3.6 681 6/21/2021
9.3.5 809 6/18/2021
9.3.4 739 6/18/2021
9.2.5 788 6/7/2021
9.2.4 726 6/6/2021
9.2.3 663 6/6/2021
9.2.2 570 6/4/2021
9.2.1 807 6/1/2021
9.2.0 764 5/26/2021
9.1.9 580 5/5/2021
9.1.8 733 5/5/2021
9.1.7 591 5/3/2021
9.1.4 599 4/21/2021
9.1.2 585 4/18/2021
9.1.1 570 4/15/2021
9.1.0 625 4/14/2021
9.0.1 691 4/12/2021
9.0.0 588 4/5/2021
8.9.92 1,163 3/30/2021
8.9.4 1,173 3/26/2021
8.9.3 1,215 3/19/2021
8.9.2 1,196 1/29/2021
8.9.1 1,263 1/24/2021
8.9.0 1,328 1/22/2021
8.7.1 1,630 11/15/2020
8.7.0 1,334 11/15/2020
8.6.9 1,271 11/8/2020
8.6.7 1,242 11/4/2020
8.6.6 1,328 11/2/2020
8.6.5 1,308 11/1/2020
8.6.3 1,330 10/30/2020
8.6.2 1,232 10/30/2020
8.6.1 1,323 10/29/2020
8.6.0 1,283 10/28/2020
8.5.1 1,271 10/26/2020
8.5.0 1,222 10/23/2020
8.4.6 1,440 10/20/2020
8.4.5 1,324 10/18/2020
8.4.4 1,344 10/17/2020
8.4.3 1,312 10/16/2020
8.4.2 1,260 10/16/2020
8.4.1 1,258 10/15/2020
8.4.0 1,337 10/13/2020
8.3.3 1,259 10/11/2020
8.3.2 1,302 10/8/2020
8.3.1 1,319 10/5/2020
8.3.0 1,281 10/3/2020
8.2.3 1,227 10/1/2020
8.2.2 1,508 9/26/2020
8.2.1 1,369 9/25/2020
8.2.0 1,402 9/25/2020
8.1.25 1,298 9/24/2020
8.1.24 1,291 9/23/2020
8.1.23 1,219 9/23/2020
8.1.22 1,290 9/21/2020
8.1.21 1,343 9/15/2020
8.1.20 1,352 9/14/2020
8.1.19 1,329 9/13/2020
8.1.18 1,297 9/13/2020
8.1.17 1,347 9/13/2020
8.1.16 1,346 9/13/2020
8.1.15 1,271 9/12/2020
8.1.13 1,166 9/11/2020
8.1.12 1,290 9/11/2020
8.1.11 1,293 9/11/2020
8.1.10 1,336 9/6/2020
8.1.9 1,334 9/3/2020
8.1.8 1,360 9/2/2020
8.1.7 1,228 8/28/2020
8.1.4 1,229 8/25/2020
8.1.3 1,408 8/18/2020
8.1.2 1,219 8/16/2020
8.1.1 1,281 8/15/2020
8.0.3 1,295 8/11/2020
8.0.2 1,317 8/7/2020
8.0.1 1,318 8/7/2020
8.0.0 1,266 8/7/2020
7.0.1 1,376 6/28/2020
7.0.0 1,368 6/28/2020
5.0.10 1,338 5/31/2020
5.0.9 1,437 5/30/2020
5.0.8 1,315 5/29/2020
5.0.7 1,292 5/29/2020
5.0.5 1,374 2/27/2020
5.0.4 1,341 2/26/2020
5.0.3 1,332 2/26/2020
5.0.2 1,338 2/25/2020
5.0.1 1,241 2/25/2020
5.0.0 1,361 2/25/2020
4.1.5 1,301 2/23/2020
4.1.4 1,383 2/23/2020
4.1.3 1,318 2/22/2020
4.1.2 1,311 2/22/2020
4.1.1 1,304 2/21/2020
4.1.0 1,334 2/21/2020
4.0.9 1,424 2/7/2020
4.0.8 1,264 2/7/2020
4.0.7 1,282 2/7/2020
4.0.5 1,294 1/28/2020
4.0.4 1,426 1/27/2020
4.0.3 1,279 1/27/2020
4.0.2 1,422 1/16/2020
4.0.1 1,444 1/11/2020
4.0.0 1,392 1/5/2020
3.1.7 1,442 12/17/2019
3.1.6 1,331 12/12/2019
3.1.5 1,329 12/12/2019
3.1.4 1,343 12/5/2019
3.1.3 1,376 12/4/2019
3.1.2 1,399 11/30/2019
3.1.1 1,560 11/26/2019
3.1.0 1,360 11/10/2019
3.0.4 1,202 11/1/2019
3.0.3 1,369 10/28/2019
3.0.2 1,383 10/28/2019
3.0.1 1,373 10/26/2019
3.0.0 1,201 10/23/2019
2.1.4 998 10/21/2019
2.1.3 1,334 10/21/2019
2.1.2 1,465 10/21/2019
2.1.1 1,342 10/19/2019
2.1.0 1,390 10/19/2019
2.0.9 1,089 10/18/2019
2.0.8 1,359 10/18/2019
2.0.7 1,095 10/18/2019
2.0.6 1,084 10/18/2019
2.0.5 1,139 10/18/2019
2.0.4 1,098 10/17/2019
2.0.3 1,231 10/16/2019
2.0.2 1,216 10/15/2019
2.0.1 1,258 10/14/2019
2.0.0 1,094 10/13/2019
1.1.7 1,427 10/11/2019
1.1.6 1,374 10/11/2019