magic.library 17.0.1

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package magic.library --version 17.0.1
                    


                    

                
NuGet\Install-Package magic.library -Version 17.0.1
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.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="magic.library" Version="17.0.1" />
                    


                            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.0.1
                    


                    

                
#r "nuget: magic.library, 17.0.1"
#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.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=magic.library&version=17.0.1
                    


                            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 6 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.

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 of Aista, Ltd 2021 - 2023, and professionally maintained by AINIRO your friendly ChatGPT website chatbot vendor.

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 954 2/17/2024
17.3.7 198 2/12/2024
17.3.6 167 2/12/2024
17.3.5 159 2/10/2024
17.3.4 152 2/9/2024
17.3.3 160 2/8/2024
17.3.2 166 2/2/2024
17.3.1 171 1/30/2024
17.2.2 143 1/30/2024
17.2.1 181 1/22/2024
17.2.0 157 1/22/2024
17.1.7 230 1/12/2024
17.1.6 187 1/11/2024
17.1.5 198 1/5/2024
17.0.1 259 1/1/2024
17.0.0 380 12/14/2023
16.11.6 255 11/14/2023
16.11.5 197 11/12/2023
16.9.0 329 10/9/2023
16.8.5 211 9/30/2023
16.8.4 199 9/25/2023
16.8.0 176 9/24/2023
16.7.51 162 9/24/2023
16.7.50 178 9/23/2023
16.7.1 223 9/4/2023
16.7.0 339 7/11/2023
16.6.13 227 7/6/2023
16.6.12 230 7/5/2023
16.6.11 211 7/5/2023
16.6.5 252 7/3/2023
16.4.4 255 7/2/2023
16.4.3 261 6/27/2023
16.4.2 249 6/25/2023
16.4.1 255 6/25/2023
16.4.0 235 6/22/2023
16.3.2 335 6/7/2023
16.3.0 355 5/28/2023
16.2.0 432 5/13/2023
16.1.10 404 5/1/2023
16.1.9 322 4/30/2023
16.1.1 347 4/20/2023
15.10.11 366 4/16/2023
15.9.40 400 4/3/2023
15.9.1 459 3/27/2023
15.9.0 467 3/24/2023
15.8.2 499 3/20/2023
15.7.0 389 3/6/2023
15.5.20 748 2/23/2023
15.5.13 553 2/13/2023
15.5.9 445 2/11/2023
15.5.2 537 2/5/2023
15.5.1 456 2/3/2023
15.5.0 518 1/28/2023
15.2.0 660 1/18/2023
15.1.0 1,135 12/28/2022
14.5.7 670 12/13/2022
14.5.5 770 12/6/2022
14.5.1 607 11/23/2022
14.5.0 555 11/18/2022
14.4.5 627 10/22/2022
14.4.2 564 10/22/2022
14.4.1 567 10/22/2022
14.4.0 594 10/17/2022
14.3.9 623 10/13/2022
14.3.6 616 10/7/2022
14.3.2 633 9/18/2022
14.3.1 709 9/12/2022
14.3.0 603 9/10/2022
14.1.3 870 8/7/2022
14.1.2 613 8/7/2022
14.1.1 627 8/7/2022
14.0.14 614 7/26/2022
14.0.12 607 7/24/2022
14.0.11 580 7/23/2022
14.0.10 602 7/23/2022
14.0.9 587 7/23/2022
14.0.8 674 7/17/2022
14.0.5 743 7/11/2022
14.0.4 675 7/7/2022
14.0.3 667 7/2/2022
14.0.2 620 7/2/2022
14.0.1 656 7/2/2022
14.0.0 644 6/25/2022
13.4.28 628 6/11/2022
13.4.25 740 6/9/2022
13.4.24 629 6/9/2022
13.4.19 684 6/8/2022
13.4.3 666 6/6/2022
13.4.2 705 6/4/2022
13.4.0 717 5/31/2022
13.3.8 697 5/19/2022
13.3.7 652 5/18/2022
13.3.6 697 5/14/2022
13.3.4 768 5/9/2022
13.3.1 709 5/1/2022
13.3.0 670 5/1/2022
13.2.2 728 4/25/2022
13.2.1 681 4/25/2022
13.2.0 715 4/21/2022
13.1.1 728 4/20/2022
13.1.0 811 4/7/2022
13.0.0 736 4/5/2022
12.0.3 907 3/14/2022
11.0.7 777 3/11/2022
11.0.5 834 3/2/2022
11.0.4 754 2/22/2022
11.0.3 758 2/9/2022
11.0.2 817 2/6/2022
11.0.1 803 2/5/2022
10.0.21 780 1/28/2022
10.0.20 789 1/27/2022
10.0.19 775 1/23/2022
10.0.18 741 1/17/2022
10.0.17 751 1/14/2022
10.0.16 612 1/2/2022
10.0.15 667 12/31/2021
10.0.14 676 12/28/2021
10.0.13 748 12/23/2021
10.0.11 536 12/23/2021
10.0.10 556 12/22/2021
10.0.9 713 12/22/2021
10.0.8 602 12/22/2021
10.0.7 757 12/22/2021
10.0.6 639 12/19/2021
10.0.5 732 12/18/2021
10.0.3 518 12/16/2021
10.0.2 604 12/14/2021
10.0.1 489 12/13/2021
10.0.0 539 12/6/2021
9.9.9 1,318 11/29/2021
9.9.6 4,789 11/24/2021
9.9.5 540 11/23/2021
9.9.4 842 11/21/2021
9.9.3 606 11/9/2021
9.9.2 635 11/4/2021
9.9.0 725 10/30/2021
9.8.9 750 10/29/2021
9.8.7 635 10/27/2021
9.8.6 643 10/27/2021
9.8.5 732 10/26/2021
9.8.4 710 10/25/2021
9.8.3 765 10/24/2021
9.8.1 634 10/21/2021
9.8.0 706 10/20/2021
9.7.9 618 10/20/2021
9.7.8 652 10/19/2021
9.7.7 885 10/17/2021
9.7.6 781 10/17/2021
9.7.5 657 10/14/2021
9.7.1 593 10/14/2021
9.7.0 672 10/9/2021
9.6.8 681 8/30/2021
9.6.7 659 8/26/2021
9.6.6 769 8/14/2021
9.6.5 878 8/11/2021
9.6.4 673 8/10/2021
9.6.3 666 8/9/2021
9.6.2 664 8/8/2021
9.6.1 619 8/8/2021
9.5.9 821 8/5/2021
9.5.8 813 8/4/2021
9.5.3 698 7/20/2021
9.5.0 1,061 7/9/2021
9.4.5 670 6/29/2021
9.4.4 814 6/29/2021
9.4.0 659 6/24/2021
9.3.7 669 6/21/2021
9.3.6 721 6/21/2021
9.3.5 846 6/18/2021
9.3.4 775 6/18/2021
9.2.5 827 6/7/2021
9.2.4 764 6/6/2021
9.2.3 702 6/6/2021
9.2.2 613 6/4/2021
9.2.1 851 6/1/2021
9.2.0 803 5/26/2021
9.1.9 628 5/5/2021
9.1.8 788 5/5/2021
9.1.7 636 5/3/2021
9.1.4 642 4/21/2021
9.1.2 626 4/18/2021
9.1.1 622 4/15/2021
9.1.0 668 4/14/2021
9.0.1 732 4/12/2021
9.0.0 632 4/5/2021
8.9.92 1,207 3/30/2021
8.9.4 1,218 3/26/2021
8.9.3 1,263 3/19/2021
8.9.2 1,251 1/29/2021
8.9.1 1,313 1/24/2021
8.9.0 1,383 1/22/2021
8.7.1 1,678 11/15/2020
8.7.0 1,380 11/15/2020
8.6.9 1,319 11/8/2020
8.6.7 1,290 11/4/2020
8.6.6 1,376 11/2/2020
8.6.5 1,359 11/1/2020
8.6.3 1,379 10/30/2020
8.6.2 1,281 10/30/2020
8.6.1 1,369 10/29/2020
8.6.0 1,329 10/28/2020
8.5.1 1,323 10/26/2020
8.5.0 1,275 10/23/2020
8.4.6 1,491 10/20/2020
8.4.5 1,377 10/18/2020
8.4.4 1,392 10/17/2020
8.4.3 1,361 10/16/2020
8.4.2 1,313 10/16/2020
8.4.1 1,307 10/15/2020
8.4.0 1,390 10/13/2020
8.3.3 1,311 10/11/2020
8.3.2 1,353 10/8/2020
8.3.1 1,373 10/5/2020
8.3.0 1,337 10/3/2020
8.2.3 1,290 10/1/2020
8.2.2 1,554 9/26/2020
8.2.1 1,423 9/25/2020
8.2.0 1,454 9/25/2020
8.1.25 1,344 9/24/2020
8.1.24 1,339 9/23/2020
8.1.23 1,274 9/23/2020
8.1.22 1,337 9/21/2020
8.1.21 1,396 9/15/2020
8.1.20 1,404 9/14/2020
8.1.19 1,377 9/13/2020
8.1.18 1,346 9/13/2020
8.1.17 1,394 9/13/2020
8.1.16 1,393 9/13/2020
8.1.15 1,326 9/12/2020
8.1.13 1,214 9/11/2020
8.1.12 1,344 9/11/2020
8.1.11 1,346 9/11/2020
8.1.10 1,381 9/6/2020
8.1.9 1,383 9/3/2020
8.1.8 1,411 9/2/2020
8.1.7 1,280 8/28/2020
8.1.4 1,284 8/25/2020
8.1.3 1,462 8/18/2020
8.1.2 1,266 8/16/2020
8.1.1 1,328 8/15/2020
8.0.3 1,343 8/11/2020
8.0.2 1,371 8/7/2020
8.0.1 1,371 8/7/2020
8.0.0 1,312 8/7/2020
7.0.1 1,425 6/28/2020
7.0.0 1,423 6/28/2020
5.0.10 1,394 5/31/2020
5.0.9 1,492 5/30/2020
5.0.8 1,362 5/29/2020
5.0.7 1,353 5/29/2020
5.0.5 1,425 2/27/2020
5.0.4 1,391 2/26/2020
5.0.3 1,381 2/26/2020
5.0.2 1,389 2/25/2020
5.0.1 1,293 2/25/2020
5.0.0 1,416 2/25/2020
4.1.5 1,355 2/23/2020
4.1.4 1,438 2/23/2020
4.1.3 1,369 2/22/2020
4.1.2 1,365 2/22/2020
4.1.1 1,354 2/21/2020
4.1.0 1,391 2/21/2020
4.0.9 1,477 2/7/2020
4.0.8 1,316 2/7/2020
4.0.7 1,337 2/7/2020
4.0.5 1,349 1/28/2020
4.0.4 1,480 1/27/2020
4.0.3 1,330 1/27/2020
4.0.2 1,476 1/16/2020
4.0.1 1,493 1/11/2020
4.0.0 1,443 1/5/2020
3.1.7 1,495 12/17/2019
3.1.6 1,384 12/12/2019
3.1.5 1,385 12/12/2019
3.1.4 1,393 12/5/2019
3.1.3 1,428 12/4/2019
3.1.2 1,453 11/30/2019
3.1.1 1,611 11/26/2019
3.1.0 1,419 11/10/2019
3.0.4 1,258 11/1/2019
3.0.3 1,422 10/28/2019
3.0.2 1,434 10/28/2019
3.0.1 1,426 10/26/2019
3.0.0 1,256 10/23/2019
2.1.4 1,053 10/21/2019
2.1.3 1,389 10/21/2019
2.1.2 1,526 10/21/2019
2.1.1 1,397 10/19/2019
2.1.0 1,450 10/19/2019
2.0.9 1,147 10/18/2019
2.0.8 1,412 10/18/2019
2.0.7 1,153 10/18/2019
2.0.6 1,137 10/18/2019
2.0.5 1,192 10/18/2019
2.0.4 1,151 10/17/2019
2.0.3 1,287 10/16/2019
2.0.2 1,276 10/15/2019
2.0.1 1,312 10/14/2019
2.0.0 1,153 10/13/2019
1.1.7 1,494 10/11/2019
1.1.6 1,433 10/11/2019