Make IResults types public

src/Http/Http.Results/src/AcceptedAtRouteResult.cs → src/Http/Http.Results/src/AcceptedAtRouteHttpResult.cs

@@ -1,56 +1,67 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+namespace Microsoft.AspNetCore.Http;
+
+using System.Threading.Tasks;
 using Microsoft.AspNetCore.Routing;
 using Microsoft.Extensions.DependencyInjection;
 
-namespace Microsoft.AspNetCore.Http.Result;
-
-internal sealed class AcceptedAtRouteResult : ObjectResult
+/// <summary>
+/// An <see cref="IResult"/> that on execution will write an object to the response
+/// with status code Accepted (202) and Location header.
+/// Targets a registered route.
+/// </summary>
+public sealed class AcceptedAtRouteHttpResult : IResult
 {
     /// <summary>
-    /// Initializes a new instance of the <see cref="AcceptedAtRouteResult"/> class with the values
+    /// Initializes a new instance of the <see cref="AcceptedAtRouteHttpResult"/> class with the values
     /// provided.
     /// </summary>
     /// <param name="routeValues">The route data to use for generating the URL.</param>
     /// <param name="value">The value to format in the entity body.</param>
-    public AcceptedAtRouteResult(object? routeValues, object? value)
+    public AcceptedAtRouteHttpResult(object? routeValues, object? value)
         : this(routeName: null, routeValues: routeValues, value: value)
     {
     }
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="AcceptedAtRouteResult"/> class with the values
+    /// Initializes a new instance of the <see cref="AcceptedAtRouteHttpResult"/> class with the values
     /// provided.
     /// </summary>
     /// <param name="routeName">The name of the route to use for generating the URL.</param>
     /// <param name="routeValues">The route data to use for generating the URL.</param>
     /// <param name="value">The value to format in the entity body.</param>
-    public AcceptedAtRouteResult(
+    public AcceptedAtRouteHttpResult(
         string? routeName,
         object? routeValues,
         object? value)
-        : base(value, StatusCodes.Status202Accepted)
     {
+        Value = value;
         RouteName = routeName;
         RouteValues = new RouteValueDictionary(routeValues);
     }
 
-    /// <summary>
-    /// Gets the name of the route to use for generating the URL.
-    /// </summary>
+    /// <inheritdoc/>
+    public object? Value { get; }
+
+    /// <inheritdoc/>
     public string? RouteName { get; }
 
-    /// <summary>
-    /// Gets the route data to use for generating the URL.
-    /// </summary>
-    public RouteValueDictionary RouteValues { get; }
+    /// <inheritdoc/>
+    public RouteValueDictionary? RouteValues { get; }
+
+    /// <inheritdoc/>
+    public int StatusCode => StatusCodes.Status202Accepted;
+
+    /// <inheritdoc/>
+    public Task ExecuteAsync(HttpContext httpContext)
+        => HttpResultsWriter.WriteResultAsJsonAsync(httpContext, Value, StatusCode, configureResponseHeader: ConfigureResponseHeaders);
 
-    /// <inheritdoc />
-    protected override void ConfigureResponseHeaders(HttpContext context)
+    private void ConfigureResponseHeaders(HttpContext context)
     {
         var linkGenerator = context.RequestServices.GetRequiredService<LinkGenerator>();
-        var url = linkGenerator.GetUriByAddress(
+        var url = linkGenerator.GetUriByRouteValues(
             context,
             RouteName,
             RouteValues,

src/Http/Http.Results/src/AcceptedHttpResult.cs

@@ -0,0 +1,76 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Microsoft.AspNetCore.Http;
+
+using System.Threading.Tasks;
+
+/// <summary>
+/// An <see cref="IResult"/> that on execution will write an object to the response
+/// with status code Accepted (202) and Location header.
+/// Targets a registered route.
+/// </summary>
+public sealed class AcceptedHttpResult : IResult
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="AcceptedHttpResult"/> class with the values
+    /// provided.
+    /// </summary>
+    /// <param name="location">The location at which the status of requested content can be monitored.</param>
+    /// <param name="value">The value to format in the entity body.</param>
+    public AcceptedHttpResult(string? location, object? value)
+    {
+        Value = value;
+        Location = location;
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="AcceptedHttpResult"/> class with the values
+    /// provided.
+    /// </summary>
+    /// <param name="locationUri">The location at which the status of requested content can be monitored.</param>
+    /// <param name="value">The value to format in the entity body.</param>
+    public AcceptedHttpResult(Uri locationUri, object? value)
+    {
+        Value = value;
+
+        if (locationUri == null)
+        {
+            throw new ArgumentNullException(nameof(locationUri));
+        }
+
+        if (locationUri.IsAbsoluteUri)
+        {
+            Location = locationUri.AbsoluteUri;
+        }
+        else
+        {
+            Location = locationUri.GetComponents(UriComponents.SerializationInfoString, UriFormat.UriEscaped);
+        }
+    }
+
+    /// <inheritdoc/>
+    public object? Value { get; }
+
+    /// <inheritdoc/>
+    public int StatusCode => StatusCodes.Status202Accepted;
+
+    /// <inheritdoc/>
+    public string? Location { get; }
+
+    /// <inheritdoc/>
+    public Task ExecuteAsync(HttpContext httpContext)
+    {
+        return HttpResultsWriter.WriteResultAsJsonAsync(
+                httpContext,
+                Value,
+                StatusCode,
+                configureResponseHeader: (context) =>
+                {
+                    if (!string.IsNullOrEmpty(Location))
+                    {
+                        context.Response.Headers.Location = Location;
+                    }
+                });
+    }
+}

src/Http/Http.Results/src/BadRequestObjectHttpResult.cs

@@ -0,0 +1,31 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Microsoft.AspNetCore.Http;
+
+/// <summary>
+/// An <see cref="IResult"/> that on execution will write an object to the response
+/// with Bad Request (400) status code.
+/// </summary>
+public sealed class BadRequestObjectHttpResult : IResult
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="BadRequestObjectHttpResult"/> class with the values
+    /// provided.
+    /// </summary>
+    /// <param name="error">The error content to format in the entity body.</param>
+    public BadRequestObjectHttpResult(object? error)
+    {
+        Value = error;
+    }
+
+    /// <inheritdoc/>
+    public object? Value { get; internal init; }
+
+    /// <inheritdoc/>
+    public int StatusCode => StatusCodes.Status400BadRequest;
+
+    /// <inheritdoc/>
+    public Task ExecuteAsync(HttpContext httpContext)
+        => HttpResultsWriter.WriteResultAsJsonAsync(httpContext, Value, StatusCode);
+}

src/Http/Http.Results/src/ChallengeResult.cs → src/Http/Http.Results/src/ChallengeHttpResult.cs

@@ -6,84 +6,91 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 
-namespace Microsoft.AspNetCore.Http.Result;
+namespace Microsoft.AspNetCore.Http;
 
 /// <summary>
 /// An <see cref="IResult"/> that on execution invokes <see cref="M:HttpContext.ChallengeAsync"/>.
 /// </summary>
-internal sealed partial class ChallengeResult : IResult
+public sealed partial class ChallengeHttpResult : IResult
 {
     /// <summary>
-    /// Initializes a new instance of <see cref="ChallengeResult"/>.
+    /// Initializes a new instance of <see cref="ChallengeHttpResult"/>.
     /// </summary>
-    public ChallengeResult()
+    public ChallengeHttpResult()
         : this(Array.Empty<string>())
     {
     }
 
     /// <summary>
-    /// Initializes a new instance of <see cref="ChallengeResult"/> with the
+    /// Initializes a new instance of <see cref="ChallengeHttpResult"/> with the
     /// specified authentication scheme.
     /// </summary>
     /// <param name="authenticationScheme">The authentication scheme to challenge.</param>
-    public ChallengeResult(string authenticationScheme)
+    public ChallengeHttpResult(string authenticationScheme)
         : this(new[] { authenticationScheme })
     {
     }
 
     /// <summary>
-    /// Initializes a new instance of <see cref="ChallengeResult"/> with the
+    /// Initializes a new instance of <see cref="ChallengeHttpResult"/> with the
     /// specified authentication schemes.
     /// </summary>
     /// <param name="authenticationSchemes">The authentication schemes to challenge.</param>
-    public ChallengeResult(IList<string> authenticationSchemes)
+    public ChallengeHttpResult(IList<string> authenticationSchemes)
         : this(authenticationSchemes, properties: null)
     {
     }
 
     /// <summary>
-    /// Initializes a new instance of <see cref="ChallengeResult"/> with the
+    /// Initializes a new instance of <see cref="ChallengeHttpResult"/> with the
     /// specified <paramref name="properties"/>.
     /// </summary>
     /// <param name="properties"><see cref="AuthenticationProperties"/> used to perform the authentication
     /// challenge.</param>
-    public ChallengeResult(AuthenticationProperties? properties)
+    public ChallengeHttpResult(AuthenticationProperties? properties)
         : this(Array.Empty<string>(), properties)
     {
     }
 
     /// <summary>
-    /// Initializes a new instance of <see cref="ChallengeResult"/> with the
+    /// Initializes a new instance of <see cref="ChallengeHttpResult"/> with the
     /// specified authentication scheme and <paramref name="properties"/>.
     /// </summary>
     /// <param name="authenticationScheme">The authentication schemes to challenge.</param>
     /// <param name="properties"><see cref="AuthenticationProperties"/> used to perform the authentication
     /// challenge.</param>
-    public ChallengeResult(string authenticationScheme, AuthenticationProperties? properties)
+    public ChallengeHttpResult(string authenticationScheme, AuthenticationProperties? properties)
         : this(new[] { authenticationScheme }, properties)
     {
     }
 
     /// <summary>
-    /// Initializes a new instance of <see cref="ChallengeResult"/> with the
+    /// Initializes a new instance of <see cref="ChallengeHttpResult"/> with the
     /// specified authentication schemes and <paramref name="properties"/>.
     /// </summary>
     /// <param name="authenticationSchemes">The authentication scheme to challenge.</param>
     /// <param name="properties"><see cref="AuthenticationProperties"/> used to perform the authentication
     /// challenge.</param>
-    public ChallengeResult(IList<string> authenticationSchemes, AuthenticationProperties? properties)
+    public ChallengeHttpResult(IList<string> authenticationSchemes, AuthenticationProperties? properties)
     {
-        AuthenticationSchemes = authenticationSchemes;
+        AuthenticationSchemes = authenticationSchemes.AsReadOnly();
         Properties = properties;
     }
 
-    public IList<string> AuthenticationSchemes { get; init; } = Array.Empty<string>();
+    /// <summary>
+    /// Gets or sets the authentication schemes that are challenged.
+    /// </summary>
+    public IReadOnlyList<string> AuthenticationSchemes { get; internal init; } = Array.Empty<string>();
 
-    public AuthenticationProperties? Properties { get; init; }
+    /// <summary>
+    /// Gets or sets the <see cref="AuthenticationProperties"/> used to perform the sign-out operation.
+    /// </summary>
+    public AuthenticationProperties? Properties { get; internal init; }
 
+    /// <inheritdoc/>
     public async Task ExecuteAsync(HttpContext httpContext)
     {
-        var logger = httpContext.RequestServices.GetRequiredService<ILogger<ChallengeResult>>();
+        var logger = httpContext.RequestServices.GetRequiredService<ILogger<ChallengeHttpResult>>();
 
         Log.ChallengeResultExecuting(logger, AuthenticationSchemes);
 
@@ -102,7 +109,7 @@ public async Task ExecuteAsync(HttpContext httpContext)
 
     private static partial class Log
     {
-        public static void ChallengeResultExecuting(ILogger logger, IList<string> authenticationSchemes)
+        public static void ChallengeResultExecuting(ILogger logger, IReadOnlyList<string> authenticationSchemes)
         {
             if (logger.IsEnabled(LogLevel.Information))
             {