IDownstreamApi overloads that take JsonTypeInfo<T> as a parameter to enable source generated Json deserialization for NativeAOT

Directory.Build.props

@@ -20,7 +20,7 @@
 	</PropertyGroup>
 
 	<PropertyGroup>
-		<TargetFrameworks>netstandard2.0;netstandard2.1;net462</TargetFrameworks>
+		<TargetFrameworks>netstandard2.0;netstandard2.1;net462;net8.0</TargetFrameworks>
 		<SignAssembly>true</SignAssembly>
 		<AssemblyOriginatorKeyFile>../../build/MSAL.snk</AssemblyOriginatorKeyFile>
 		<GenerateDocumentationFile>true</GenerateDocumentationFile>

src/Microsoft.Identity.Abstractions/DownstreamApi/IDownstreamApi.HttpMethods.tt

@@ -8,13 +8,17 @@
 // Licensed under the MIT License.
 
 using System;
-using System.Diagnostics.CodeAnalysis;
 using System.Net.Http;
 using System.Security.Claims;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.Identity.Abstractions;
 
+#if NET8_0_OR_GREATER
+using System.Diagnostics.CodeAnalysis;
+using System.Text.Json.Serialization.Metadata;
+#endif
+
 namespace Microsoft.Identity.Abstractions
 {
     /// <summary>
@@ -24,9 +28,20 @@ namespace Microsoft.Identity.Abstractions
     public partial interface IDownstreamApi
     {
 <#
+  foreach(string framework in new string[]{  "all", "net8" } )
+  {
+
+    if (framework == "net8")
+    {
+#>
+
+#if NET8_0_OR_GREATER
+<#
+    }
+
   foreach(string httpMethod in new string[]{  "Get", "Post", "Put", "Patch", "Delete"} )
   {
-   if (httpMethod == "Patch")
+   if (httpMethod == "Patch" && framework != "net8")
    {
 #>
 
@@ -63,6 +78,12 @@ namespace Microsoft.Identity.Abstractions
 <# } #>
 <# if (hasOutput){ #>
         /// <typeparam name="TOutput">Generic output type.</typeparam>
+<# } #>
+<# if (hasInput && framework == "net8"){ #>
+        /// <param name="inputJsonTypeInfo">JSON serialization metadata for TInput</param>
+<# } #>
+<# if (hasOutput && framework == "net8"){ #>
+        /// <param name="outputJsonTypeInfo">JSON serialization metadata for TOutput</param>
 <# } #>
         /// <param name="serviceName">Name of the service describing the downstream API. There can
         /// be several configuration named sections mapped to a <see cref="DownstreamApiOptions"/>,
@@ -93,13 +114,21 @@ namespace Microsoft.Identity.Abstractions
         ///         });
         /// </code>
         /// </example>
+<# if (framework != "net8"){ #>
 #if NET6_0_OR_GREATER
         [RequiresUnreferencedCode("This method's implementations also use generic types and are not trim-friendly.")]
 #endif
+<# } #>
         public <#= returnType #> <#= httpMethod #>For<#= token #>Async<#= template #>(
             string? serviceName,
 <# if (hasInput){ #>
             TInput input,
+<# } #>
+<# if (hasInput && framework == "net8"){ #>
+            JsonTypeInfo<TInput> inputJsonTypeInfo,
+<# } #>
+<# if (hasOutput && framework == "net8"){ #>
+            JsonTypeInfo<TOutput> outputJsonTypeInfo,
 <# } #>
             Action<DownstreamApiOptionsReadOnlyHttpMethod>? downstreamApiOptionsOverride = null,
 <# if (!hasApp){ #>
@@ -111,14 +140,18 @@ namespace Microsoft.Identity.Abstractions
    }
 #>
 <#
-     if (httpMethod == "Patch")
+     if (httpMethod == "Patch" && framework != "net8")
      {
 #>
 
 #endif // NETSTANDARD2_1_OR_GREATER
 <#
-    }
-  }
+        }
+      }
+if (framework == "net8") {#>
+#endif // NET8_0_OR_GREATER
+<#}
+}
 #>
     }
 }

src/Microsoft.Identity.Abstractions/DownstreamApi/IDownstreamApi.cs

@@ -2,12 +2,16 @@
 // Licensed under the MIT License.
 
 using System;
-using System.Diagnostics.CodeAnalysis;
 using System.Net.Http;
 using System.Security.Claims;
 using System.Threading;
 using System.Threading.Tasks;
 
+#if NET8_0_OR_GREATER
+using System.Text.Json.Serialization.Metadata;
+using System.Diagnostics.CodeAnalysis;
+#endif
+
 namespace Microsoft.Identity.Abstractions
 {
     /// <summary>
@@ -236,5 +240,136 @@ Task<HttpResponseMessage> CallApiForAppAsync(
             Action<DownstreamApiOptions>? downstreamApiOptionsOverride = null,
             CancellationToken cancellationToken = default)
             where TOutput : class;
+
+#if NET8_0_OR_GREATER
+        /// <summary>
+        /// Calls a downstream API consuming JSON with some data and returns data.
+        /// </summary>
+        /// <typeparam name="TInput">Input type.</typeparam>
+        /// <typeparam name="TOutput">Output type.</typeparam>
+        /// <param name="serviceName">Name of the service describing the downstream API. There can
+        /// be several configuration named sections mapped to a <see cref="DownstreamApiOptions"/>,
+        /// each for one downstream API. You can pass-in null, but in that case <paramref name="downstreamApiOptionsOverride"/>
+        /// needs to be set.</param>
+        /// <param name="input">Input parameter to the downstream web API.</param>
+        /// <param name="inputJsonTypeInfo">JSON serialization metadata for TInput</param>
+        /// <param name="outputJsonTypeInfo">JSON serialization metadata for TOutput</param>
+        /// <param name="downstreamApiOptionsOverride">Overrides the options proposed in the configuration described
+        /// by <paramref name="serviceName"/>.</param>
+        /// <param name="user">[Optional] Claims representing a user. This is useful in platforms like Blazor
+        /// or Azure Signal R, where the HttpContext is not available. In other platforms, the library
+        /// will find the user from the HttpContext.</param>
+        /// <param name="cancellationToken">Cancellation token.</param>
+        /// <returns>The value returned by the downstream web API.</returns>
+        /// <example>
+        /// A list method that returns an IEnumerable&lt;MyItem&gt;&gt;.
+        /// <code>
+        /// public Task&lt;IEnumerable&lt;MyItem&gt;&gt; GetAsync()
+        /// {
+        ///  return _downstreamWebApi.CallWebApiForUserAsync&lt;object, IEnumerable&lt;MyItem&gt;&gt;(
+        ///         ServiceName,
+        ///         null,
+        ///         options =>
+        ///         {
+        ///           options.RelativePath = $"api/todolist";
+        ///         });
+        /// }
+        /// </code>
+        ///
+        /// Example of editing.
+        /// <code>
+        /// public Task&lt;MyItem&gt; EditAsync(MyItem myItem)
+        /// {
+        ///   return _downstreamWebApi.CallWebApiForUserAsync&lt;MyItem, MyItem&gt;(
+        ///         ServiceName,
+        ///         nyItem,
+        ///         options =>
+        ///         {
+        ///            options.HttpMethod = HttpMethod.Patch;
+        ///            options.RelativePath = $"api/todolist/{myItem.Id}";
+        ///         });
+        /// }
+        /// </code>
+        /// </example>
+        public Task<TOutput?> CallApiForUserAsync<TInput, TOutput>(
+            string? serviceName,
+            TInput input,
+            JsonTypeInfo<TInput> inputJsonTypeInfo,
+            JsonTypeInfo<TOutput> outputJsonTypeInfo,
+            Action<DownstreamApiOptions>? downstreamApiOptionsOverride = null,
+            ClaimsPrincipal? user = default,
+            CancellationToken cancellationToken = default)
+            where TOutput : class;
+
+        /// <summary>
+        /// Call a web API endpoint with an HttpGet, and return strongly typed data.
+        /// </summary>
+        /// <typeparam name="TOutput">Output type.</typeparam>
+        /// <param name="serviceName">Name of the service describing the downstream API. There can
+        /// be several configuration named sections mapped to a <see cref="DownstreamApiOptions"/>,
+        /// each for one downstream API. You can pass-in null, but in that case <paramref name="downstreamApiOptionsOverride"/>
+        /// needs to be set.</param>
+        /// <param name="outputJsonTypeInfo">JSON serialization metadata for TOutput</param>
+        /// <param name="downstreamApiOptionsOverride">Overrides the options proposed in the configuration described
+        /// by <paramref name="serviceName"/>.</param>
+        /// <param name="user">[Optional] Claims representing a user. This is useful in platforms like Blazor
+        /// or Azure Signal R, where the HttpContext is not available. In other platforms, the library
+        /// will find the user from the HttpContext.</param>
+        /// <param name="cancellationToken">Cancellation token.</param>
+        /// <returns>The value returned by the downstream web API.</returns>
+        public Task<TOutput?> CallApiForUserAsync<TOutput>(
+            string serviceName,
+            JsonTypeInfo<TOutput> outputJsonTypeInfo,
+            Action<DownstreamApiOptions>? downstreamApiOptionsOverride = null,
+            ClaimsPrincipal? user = default,
+            CancellationToken cancellationToken = default)
+            where TOutput : class;
+
+        /// <summary>
+        /// Calls a downstream API consuming JSON with some data and returns data.
+        /// </summary>
+        /// <typeparam name="TInput">Input type.</typeparam>
+        /// <typeparam name="TOutput">Output type.</typeparam>
+        /// <param name="serviceName">Name of the service describing the downstream API. There can
+        /// be several configuration named sections mapped to a <see cref="DownstreamApiOptions"/>,
+        /// each for one downstream API. You can pass-in null, but in that case <paramref name="downstreamApiOptionsOverride"/>
+        /// needs to be set.</param>
+        /// <param name="input">Input parameter to the downstream web API.</param>
+        /// <param name="inputJsonTypeInfo">JSON serialization metadata for TInput</param>
+        /// <param name="outputJsonTypeInfo">JSON serialization metadata for TOutput</param>
+        /// <param name="downstreamApiOptionsOverride">Overrides the options proposed in the configuration described
+        /// by <paramref name="serviceName"/>.</param>
+        /// <param name="cancellationToken">Cancellation token.</param>
+        /// <returns>The value returned by the downstream web API.</returns>
+        public Task<TOutput?> CallApiForAppAsync<TInput, TOutput>(
+            string? serviceName,
+            TInput input,
+            JsonTypeInfo<TInput> inputJsonTypeInfo,
+            JsonTypeInfo<TOutput> outputJsonTypeInfo,
+            Action<DownstreamApiOptions>? downstreamApiOptionsOverride = null,
+            CancellationToken cancellationToken = default)
+            where TOutput : class;
+
+        /// <summary>
+        /// Call a web API endpoint with an HttpGet, and return strongly typed data.
+        /// </summary>
+        /// <typeparam name="TOutput">Output type.</typeparam>
+        /// <param name="serviceName">Name of the service describing the downstream API. There can
+        /// be several configuration named sections mapped to a <see cref="DownstreamApiOptions"/>,
+        /// each for one downstream API. You can pass-in null, but in that case <paramref name="downstreamApiOptionsOverride"/>
+        /// needs to be set.</param>
+        /// <param name="outputJsonTypeInfo">JSON serialization metadata for TOutput</param>
+        /// <param name="downstreamApiOptionsOverride">Overrides the options proposed in the configuration described
+        /// by <paramref name="serviceName"/>.</param>
+        /// <param name="cancellationToken">Cancellation token.</param>
+        /// <returns>The value returned by the downstream web API.</returns>
+        public Task<TOutput?> CallApiForAppAsync<TOutput>(
+            string serviceName,
+            JsonTypeInfo<TOutput> outputJsonTypeInfo,
+            Action<DownstreamApiOptions>? downstreamApiOptionsOverride = null,
+            CancellationToken cancellationToken = default)
+            where TOutput : class;
+#endif
     }
+
 }

src/Microsoft.Identity.Abstractions/Microsoft.Identity.Abstractions.csproj

@@ -26,5 +26,4 @@
       <DependentUpon>IDownstreamApi.HttpMethods.tt</DependentUpon>
     </Compile>
   </ItemGroup>
-
 </Project>

test/Microsoft.Identity.Abstractions.Tests/CustomDownstreamApi.cs

@@ -9,7 +9,7 @@
 
 namespace Microsoft.Identity.Abstractions.DownstreamApi.Tests
 {
-    internal class CustomDownstreamApi : IDownstreamApi
+    internal partial class CustomDownstreamApi : IDownstreamApi
     {
         public CustomDownstreamApi()
         {