HyperDev.Web.Remoting 1.2.4

HyperDev.Web.Remoting

ASP.NET Core remoting server: exposes a graph of remote objects to the browser through one MVC controller, part of the HyperDev Fatum framework. Remote objects are described with HyperDev.Remoting; the matching Angular client is generated by HyperDev.TypeScript.Remoting.

• RemoteController<T>: invokes the remote methods of T (POST form data, or GET for methods with [RemotePolicy(UseHttpGet = true)])
• Activation of child objects from their URI ([UriActivator]), with client state ($caller) applied according to the protection rules
• OData query options (filter, order, paging, count) on IQueryable methods marked with [RemoteQueryable]
• Cache-Control headers from [RemoteCache] on GET requests
• File parameters (HyperDev.IO.IFile) from multipart uploads
• Cross-site request check (AddRemotingCsrf, modes Off, Audit, Enforce)
• Errors as ProblemDetails; overridable hooks (IsHandledException, OnBeforeInvoke, OnAfterInvoke, GetSerializerSettings)

Installation

dotnet add package HyperDev.Web.Remoting

Quick start

using HyperDev.Remoting;
using HyperDev.Web.Remoting;
using Microsoft.AspNetCore.Mvc;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllers();

builder.AddRemotingCsrf(); // "Remoting:Csrf" section: Mode = Off | Audit | Enforce

var app = builder.Build();

app.MapControllers();

app.Run();

[Route("api/shop")]
public class ShopController : RemoteController<Shop>
{
    public ShopController(ILogger<ShopController> logger)
        : base(logger)
    { }

    protected override Shop CreateInstance() => new Shop();

    // Returned to the client as 422 warnings instead of 500 errors
    protected override bool IsHandledException(Exception ex) => ex is InvalidOperationException;
}

public class Shop
{
    public string Hello(string name) => $"Hello {name}";

    [RemoteQueryable(PageSize = 50)]
    public IQueryable<Product> GetProducts() => new List<Product>().AsQueryable();
}

public class Product
{
    public int Id { get; set; }

    public string Name { get; set; }
}

Target frameworks

.NET 8.0, .NET 10.0

License

MIT, © Ivan Senatore, Wemake Informatica srl. Third-party dependencies keep their own licenses (Microsoft.AspNetCore.OData: MIT, Newtonsoft.Json: MIT, Newtonsoft.Json.Schema: commercial or AGPL-3.0, Antlr4.Runtime: BSD-3-Clause).