Merge branch 'release/2.3.0'

Author: Jaben

.github/workflows/deploy.yml

@@ -15,16 +15,16 @@ jobs:
     - name: Setup Dotnet
       uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: 7.0.405
+        dotnet-version: 8.0.x
 
     - name: Install GitVersion
-      uses: gittools/actions/gitversion/setup@v0.9.7
+      uses: gittools/actions/gitversion/setup@v1.1.1
       with:
         versionSpec: '5.x'
 
     - name: GitVersion
       id: gitversion
-      uses: gittools/actions/gitversion/execute@v0.9.7
+      uses: gittools/actions/gitversion/execute@v1.1.1
       with:
         useConfigFile: true
 

lib/Domain/Builders/Faceted/HtmlConversionBehaviorBuilder.cs

@@ -74,6 +74,7 @@ public HtmlConversionBehaviorBuilder SetBrowserWaitExpression(string expression)
     /// <returns></returns>
     /// <exception cref="InvalidOperationException"></exception>
     [PublicAPI]
+    [Obsolete("Deprecated in Gotenberg v8+")]
     public HtmlConversionBehaviorBuilder SetUserAgent(string userAgent)
     {
         if (userAgent.IsNotSet()) throw new InvalidOperationException("headerName is not set");

lib/Domain/Builders/MergeOfficeBuilder.cs

@@ -23,7 +23,7 @@ namespace Gotenberg.Sharp.API.Client.Domain.Builders;
 /// <summary>
 ///     Any non office files sent in are just ignored.
 ///     A nice surprise: Gotenberg/Chrome will merge in all sheets within a multi-sheet excel workbook.
-///     If you send in a csv file but with an xlsx extension, it will merge it in as text.
+///     If you send in a csv file but with a xlsx extension, it will merge it in as text.
 /// </summary>
 public sealed class MergeOfficeBuilder : BaseMergeBuilder<MergeOfficeRequest, MergeOfficeBuilder>
 {
@@ -39,12 +39,33 @@ public MergeOfficeBuilder PrintAsLandscape()
         return this;
     }
 
+    /// <summary>
+    ///     If provided, the API will return a pdf containing the pages in the specified range.
+    /// </summary>
+    /// <remarks>
+    ///     The format is the same as the one from the print options of Google Chrome, e.g. 1-5,8,11-13.
+    ///     This may move...
+    /// </remarks>
     [PublicAPI]
     public MergeOfficeBuilder SetPageRanges(string pageRanges)
     {
         this.Request.PageRanges = pageRanges;
         return this;
     }
+    
+    /// <summary>
+    /// Set whether to export the form fields or to use the inputted/selected
+    /// content of the fields. Default is TRUE.
+    /// </summary>
+    /// <remarks>
+    /// Gotenberg v8.3+
+    /// </remarks>
+    [PublicAPI]
+    public MergeOfficeBuilder SetExportFormFields(bool exportFormFields)
+    {
+        this.Request.ExportFormFields = exportFormFields;
+        return this;
+    }
 
     /// <summary>
     ///     This tells gotenberg to use unoconv to perform the conversion.

lib/Domain/Requests/Facets/RequestConfig.cs

@@ -79,7 +79,7 @@ public void Validate()
     /// <remarks>
     ///     Attention: this feature does not work if the form field webHookURL is given.
     /// </remarks>
-    // Not sure this is useful with the way this client is used, although.. maybe Webhook requests honor it?
+    // Not sure if this is useful with the way this client is used, although.. maybe Webhook requests honor it?
     public string? ResultFileName { get; set; }
 
     /// <summary>

lib/Domain/Requests/MergeOfficeRequest.cs

@@ -35,7 +35,23 @@ protected override string ApiPath
 
     public bool PrintAsLandscape { get; set; }
 
+    /// <summary>
+    ///     If provided, the API will return a pdf containing the pages in the specified range.
+    /// </summary>
+    /// <remarks>
+    ///     The format is the same as the one from the print options of Google Chrome, e.g. 1-5,8,11-13.
+    ///     This may move...
+    /// </remarks>
     public string? PageRanges { get; set; }
+    
+    /// <summary>
+    /// Set whether to export the form fields or to use the inputted/selected
+    /// content of the fields. Default is TRUE.
+    /// </summary>
+    /// <remarks>
+    /// Gotenberg v8.3+
+    /// </remarks>
+    public bool? ExportFormFields { get; set; }
 
     /// <summary>
     ///     Tells gotenberg to perform the conversion with unoconv.

lib/Extensions/MergeOfficeRequestExtensions.cs

@@ -34,6 +34,11 @@ internal static IEnumerable<HttpContent> PropertiesToHttpContent(this MergeOffic
             yield return BuildRequestBase.CreateFormDataItem(
                 request.PageRanges,
                 Constants.Gotenberg.LibreOffice.Routes.Convert.PageRanges);
+        
+        if (request.ExportFormFields.HasValue)
+            yield return BuildRequestBase.CreateFormDataItem(
+                request.ExportFormFields.Value,
+                Constants.Gotenberg.LibreOffice.Routes.Convert.ExportFormFields);
 
         if (!request.UseNativePdfFormat && request.Format == default) yield break;
 

lib/Gotenberg.Sharp.Api.Client.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
 	<PropertyGroup>
-		<TargetFrameworks>net7.0;net6.0;net5.0;netstandard2.1;netstandard2.0</TargetFrameworks>
+		<TargetFrameworks>net8.0;net7.0;net6.0;net5.0;netstandard2.1;netstandard2.0</TargetFrameworks>
 		<LangVersion>latest</LangVersion>
 		<AssemblyName>Gotenberg.Sharp.API.Client</AssemblyName>
 		<RootNamespace>Gotenberg.Sharp.API.Client</RootNamespace>
@@ -13,13 +13,14 @@
 	</PropertyGroup>
 
 	<PropertyGroup Label="PackageInfo">
-		<PackageVersion>2.2.2</PackageVersion>
+		<PackageVersion>2.3.0</PackageVersion>
 		<PackageTags>Gotenberg pdf C# ApiClient unoconv</PackageTags>
 		<Description>
 		C# API client for interacting with the Gotenberg v7 &amp; v8 micro-service's API, a docker-powered stateless API for converting &amp; merging HTML, Markdown and Office documents to PDF. The client supports a configurable Polly retry policy with exponential back-off for handling transient exceptions.
 		</Description>
 		<IncludeSymbols>True</IncludeSymbols>
 		<PackageReleaseNotes>
+			v2.3 - Added Convert Page 'ExportFormFields' flag support (Gotenberg v8.3+ Only). Added .NET 8 target.
 			v2.2 - Added 'SkipNetworkIdle' flag support (Gotenberg v8+ Only). Thank you for the PR @guillaumeduhr! Upgraded nugets to latest. Added .NET 7.0 support.
 			v2.1 - Added Trace Support. Fixed extra webhook header support.
 			v2.0 - Upgraded to support Gotenberg v7 -- this version no longer works with Gotenberg v6.
@@ -84,6 +85,12 @@
 		<PackageReference Include="Microsoft.Extensions.Http.Polly" Version="7.0.0" />
 	</ItemGroup>
 
+	<ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
+		<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="8.0.0" />
+		<PackageReference Include="Microsoft.Extensions.Http" Version="8.0.0" />
+		<PackageReference Include="Microsoft.Extensions.Http.Polly" Version="8.0.4" />
+	</ItemGroup>	
+
 	<ItemGroup>
 		<None Include="..\README.md" Pack="true" PackagePath="\" />
 		<None Include="..\.editorconfig" Link=".editorconfig" />

lib/Infrastructure/Constants.cs

@@ -99,6 +99,8 @@ public static class Convert
                     public const string Landscape = CrossCutting.Landscape;
 
                     public const string PageRanges = CrossCutting.PageRanges;
+                    
+                    public const string ExportFormFields = "exportFormFields";
 
                     public const string NativePdfFormat = "nativePdfFormat";