Merge branch 'release/2.0.0' into master

Author: Jaben

.editorconfig

@@ -0,0 +1,4 @@
+[*.cs]
+
+# IDE0042: Deconstruct variable declaration
+dotnet_diagnostic.IDE0042.severity = none

.github/workflows/deploy.yml

@@ -0,0 +1,37 @@
+name: Build and Push to Nuget
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+        
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+ 
+    - name: Setup Dotnet
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: 6.0.100
+        
+    - name: Install GitVersion
+      uses: gittools/actions/gitversion/setup@v0.9.7
+      with:
+        versionSpec: '5.x'        
+        
+    - name: GitVersion
+      id: gitversion
+      uses: gittools/actions/gitversion/execute@v0.9.7
+      with:
+        useConfigFile: true
+        
+    - name: Pack
+      run: dotnet pack -c Release --version-suffix ${{ steps.gitversion.outputs.nuGetVersion }}
+        
+    - name: Publish
+      if: github.event_name != 'pull_request' && (github.ref_name == 'master')
+      run: |
+        dotnet nuget push **/*.nupkg --source 'https://api.nuget.org/v3/index.json' --skip-duplicate -k ${{ secrets.NUGETKEY }} --no-symbols 1 

GitVersion.yml

@@ -0,0 +1,5 @@
+mode: Mainline
+branches: {}
+ignore:
+  sha: []
+merge-message-formats: {}

GotenbergSharpApiClient.sln

@@ -1,10 +1,15 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio Version 16
-VisualStudioVersion = 16.0.30011.22
+# Visual Studio Version 17
+VisualStudioVersion = 17.0.32112.339
 MinimumVisualStudioVersion = 15.0.26124.0
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Gotenberg.Sharp.Api.Client", "lib\Gotenberg.Sharp.Api.Client.csproj", "{75F783A4-9392-412F-9DFE-00EE89527C10}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{FE638D0D-6A76-4BF4-AF06-D8AAB9726723}"
+	ProjectSection(SolutionItems) = preProject
+		.editorconfig = .editorconfig
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU

GotenbergSharpApiClient.sln.DotSettings

@@ -1,10 +1,18 @@
 <wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Backoff/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=Consts/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=deliverables/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=epub/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=fodg/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=fodp/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=fods/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=fodt/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Gotenberg/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=Gotenberg_0027s/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Libre/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Pdfs/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=potm/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Rpcc/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=suppressions/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=unoconv/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Webhook/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>

README.md

@@ -1,17 +1,21 @@
+⭐ For Gotenberg v7+. Beta⭐
+
 # <img src="https://github.com/ChangemakerStudios/GotenbergSharpApiClient/raw/master/lib/Resources/gotenbergSharpClient.PNG" width="24" height="24" /> Gotenberg.Sharp.Api.Client
 
-[![NuGet version](https://badge.fury.io/nu/Gotenberg.Sharp.Api.Client.svg)](https://badge.fury.io/nu/Gotenberg.Sharp.Api.Client) [![Build status](https://ci.appveyor.com/api/projects/status/s8lvj93xewlsylxh/branch/master?svg=true)](https://ci.appveyor.com/project/Jaben/gotenbergsharpapiclient/branch/master) [![Downloads](https://img.shields.io/nuget/dt/Gotenberg.Sharp.API.Client.svg?logo=nuget&color=purple)](https://www.nuget.org/packages/Gotenberg.Sharp.API.Client) 
+[![NuGet version](https://badge.fury.io/nu/Gotenberg.Sharp.Api.Client.svg)](https://badge.fury.io/nu/Gotenberg.Sharp.Api.Client) [![Build status](https://ci.appveyor.com/api/projects/status/s8lvj93xewlsylxh?svg=true)](https://ci.appveyor.com/project/Jaben/gotenbergsharpapiclient) [![Downloads](https://img.shields.io/nuget/dt/Gotenberg.Sharp.API.Client.svg?logo=nuget&color=purple)](https://www.nuget.org/packages/Gotenberg.Sharp.API.Client) 
+
+.NET C# Client for interacting with the [Gotenberg](https://gotenberg.dev/) micro-service's API. [Gotenberg](https://github.com/gotenberg/gotenberg) is a [Docker-powered stateless API](https://hub.docker.com/r/gotenberg/gotenberg/) for converting & merging HTML, Markdown and Office documents to PDF. The client supports a configurable [Polly](http://www.thepollyproject.org/) **retry policy** with exponential backoff for handling transient exceptions.
 
-.NET C# Client for interacting with the [Gotenberg](https://thecodingmachine.github.io/gotenberg) micro-service's API. [Gotenberg](https://github.com/thecodingmachine/gotenberg) is a [Docker-powered stateless API](https://hub.docker.com/r/thecodingmachine/gotenberg) for converting & merging HTML, Markdown and Office documents to PDF. The client supports a configurable [Polly](http://www.thepollyproject.org/) **retry policy** with exponential backoff for handling transient exceptions.
+*As of version [2.0.0-alpha0002](https://www.nuget.org/packages/Gotenberg.Sharp.API.Client/2.0.0-alpha0002#supportedframeworks-tab) Gotenberg.Sharp.API.Client targets net6.0, net5.0; netstandard 2.0 and 2.1* 
 
 # Getting Started
 *Pull the image from dockerhub.com*
 ```powershell
-> docker pull thecodingmachine/gotenberg:latest
+> docker pull gotenberg/gotenberg:latest
 ```
 *Create & start a container*
 ```powershell
-docker run --name gotenbee -e DEFAULT_WAIT_TIMEOUT=1800 -e MAXIMUM_WAIT_TIMEOUT=1800 -e LOG_LEVEL=DEBUG -p:3000:3000 "thecodingmachine/gotenberg:latest"
+docker run --name gotenbee7x --rm -p 3000:3000 gotenberg/gotenberg:latest gotenberg --api-timeout=1800s --log-level=debug
 ```
 # .NET Core Project Setup
 *Install nuget package into your project*
@@ -22,7 +26,7 @@ PM> Install-Package Gotenberg.Sharp.Api.Client
 ```json
   "GotenbergSharpClient": {
     "ServiceUrl": "http://localhost:3000",
-    "HealthCheckUrl": "http://localhost:3000/ping",
+    "HealthCheckUrl": "http://localhost:3000/health",
     "RetryPolicy": {
       "Enabled": true,
       "RetryCount": 4,
@@ -44,9 +48,11 @@ public void ConfigureServices(IServiceCollection services)
 }
 
 ```
-# Using GotenbergSharpClient
+# Using GotenbergSharpClient.
 *See the [linqPad folder](linqpad/)* for complete examples. 
 
+### Note: Samples below are currently stale. Linqpad scripts are fresh.
+
 ## Html To Pdf 
 *With embedded assets:*
 
@@ -62,12 +68,7 @@ public void ConfigureServices(IServiceCollection services)
              dims.SetPaperSize(PaperSizes.A3)
                  .SetMargins(Margins.None)
                  .SetScale(.99);
-         }).WithAsyncAssets(async assets => assets.AddItem("some-image.jpg", await GetImageBytes()))
-         .ConfigureRequest(config =>
-         {
-             config.ChromeRpccBufferSize(1024)
-                 .PageRanges("1");
-         });
+         }).WithAsyncAssets(async assets => assets.AddItem("some-image.jpg", await GetImageBytes()));
 
      var req = await builder.BuildAsync();
 
@@ -87,7 +88,7 @@ public async Task<Stream> CreateFromUrl(string headerPath, string footerPath)
 		.SetUrl("https://www.cnn.com")
 		.ConfigureRequest(config =>
 		{
-			config.PageRanges("1-2").ChromeRpccBufferSize(1048576);
+			config.PageRanges("1-2");
 		})
 		.AddAsyncHeaderFooter(async
 			doc => doc.SetHeader(await File.ReadAllTextAsync(headerPath))
@@ -111,11 +112,7 @@ public async Task<Stream> CreateFromUrl(string headerPath, string footerPath)
 public async Task<Stream> DoOfficeMerge(string sourceDirectory)
 {
 	var builder = new MergeOfficeBuilder()
-		.WithAsyncAssets(async a => a.AddItems(await GetDocsAsync(sourceDirectory)))
-		.ConfigureRequest(config =>
-		{
-			config.TimeOut(100);
-		});
+		.WithAsyncAssets(async a => a.AddItems(await GetDocsAsync(sourceDirectory)));
 
 	var request = await builder.BuildAsync();
 	return await _sharpClient.MergeOfficeDocsAsync(request);
@@ -138,10 +135,7 @@ public async Task<Stream> CreateFromMarkdown()
 			dims.UseChromeDefaults().LandScape().SetScale(.90);
 		}).WithAsyncAssets(async
 			a => a.AddItems(await GetMarkdownAssets())
-		).ConfigureRequest(req =>
-		{
-			req.ChromeRpccBufferSize(1048555);
-		});
+		));
 
 	var request = await builder.BuildAsync();
 	return await _sharpClient.HtmlToPdfAsync(request);
@@ -163,12 +157,11 @@ public async Task<Stream> CreateFromMarkdown()
                          .SetUrl("http://host.docker.internal:5000/api/your/webhookReceiver")
                          .AddRequestHeader("custom-header", "value");
                  })
-                 .PageRanges("1-2")
-                 .ChromeRpccBufferSize(1048576);
+                 .PageRanges("1-2");
          })
          .AddAsyncHeaderFooter(async
-             docBuilder => docBuilder.SetHeader(await System.IO.File.ReadAllTextAsync(headerPath))
-                 .SetFooter(await System.IO.File.ReadAllBytesAsync(footerPath))
+             b => b.SetHeader(await System.IO.File.ReadAllTextAsync(headerPath))
+                   .SetFooter(await System.IO.File.ReadAllBytesAsync(footerPath))
          ).WithDimensions(dimBuilder =>
          {
              dimBuilder.SetPaperSize(PaperSizes.A4)
@@ -240,11 +233,11 @@ async Task<Stream> ExecuteRequestsAndMerge(IEnumerable<UrlRequest> requests)
     var results = await Task.WhenAll(tasks);
 
     var mergeBuilder = new MergeBuilder()
-        .WithAssets(b => 
-			{ b.AddItems(results.Select((r, i) => KeyValuePair.Create($"{i}.pdf", r))); }
-		).ConfigureRequest(b => b.TimeOut(1799));
+        .WithAssets(b => { 
+            b.AddItems(results.Select((r, i) => KeyValuePair.Create($"{i}.pdf", r))); 
+        });
 
     var request = mergeBuilder.Build();
     return await _sharpClient.MergePdfsAsync(request);
 }
-``` 
+``` 

appveyor.yml

@@ -1,6 +1,10 @@
-version: 1.0.{build}
+version: 2.0.{build}
 
-image: Visual Studio 2019
+image: Visual Studio 2022
+
+branches:
+  except:
+    - /feature\/.+/
 
 configuration: Release
 

lib/Domain/Builders/BaseBuilder.cs

@@ -1,11 +1,34 @@
-using Gotenberg.Sharp.API.Client.Domain.Requests;
+using System;
+
+using Gotenberg.Sharp.API.Client.Domain.Builders.Faceted;
+using Gotenberg.Sharp.API.Client.Domain.Requests;
+using Gotenberg.Sharp.API.Client.Domain.Requests.Facets;
+
+using JetBrains.Annotations;
 
 namespace Gotenberg.Sharp.API.Client.Domain.Builders
 {
-    public abstract class BaseBuilder<TRequest> where TRequest : RequestBase
+    public abstract class BaseBuilder<TRequest, TBuilder>
+        where TRequest : RequestBase
+        where TBuilder : BaseBuilder<TRequest, TBuilder>
     {
         protected virtual TRequest Request { get; set; }
 
         protected const string CallBuildAsyncErrorMessage = "Request has asynchronous items. Call BuildAsync instead.";
+
+        [PublicAPI]
+        public TBuilder ConfigureRequest(Action<ConfigBuilder> action)
+        {
+            if (action == null) throw new ArgumentNullException(nameof(action));
+            action(new ConfigBuilder(this.Request));
+            return (TBuilder) this;
+        }
+
+        [PublicAPI]
+        public TBuilder ConfigureRequest(RequestConfig config)
+        {
+            this.Request.Config = config ?? throw new ArgumentNullException(nameof(config));
+            return (TBuilder) this;
+        }
     }
 }

lib/Domain/Builders/BaseChromiumBuilder.cs

@@ -0,0 +1,65 @@
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+
+using Gotenberg.Sharp.API.Client.Domain.Builders.Faceted;
+using Gotenberg.Sharp.API.Client.Domain.Requests;
+using Gotenberg.Sharp.API.Client.Domain.Requests.Facets;
+
+using JetBrains.Annotations;
+
+namespace Gotenberg.Sharp.API.Client.Domain.Builders;
+
+public abstract class BaseChromiumBuilder<TRequest, TBuilder> : BaseBuilder<TRequest, TBuilder>
+    where TRequest : ChromeRequest
+    where TBuilder : BaseChromiumBuilder<TRequest, TBuilder>
+{
+    protected readonly List<Task> AsyncTasks = new List<Task>();
+
+    [PublicAPI]
+    public TBuilder WithDimensions(Action<DimensionBuilder> action)
+    {
+        if (action == null) throw new ArgumentNullException(nameof(action));
+
+        action(new DimensionBuilder(this.Request));
+        return (TBuilder) this;
+    }
+
+    [PublicAPI]
+    public TBuilder WithDimensions(Dimensions dimensions)
+    {
+        this.Request.Dimensions = dimensions ?? throw new ArgumentNullException(nameof(dimensions));
+        return (TBuilder) this;
+    }
+
+    [PublicAPI]
+    public TBuilder WithAssets(Action<AssetBuilder> action)
+    {
+        if (action == null) throw new ArgumentNullException(nameof(action));
+        action(new AssetBuilder(this.Request));
+        return (TBuilder) this;
+    }
+
+    [PublicAPI]
+    public TBuilder WithAsyncAssets(Func<AssetBuilder, Task> asyncAction)
+    {
+        if (asyncAction == null) throw new ArgumentNullException(nameof(asyncAction));
+        this.AsyncTasks.Add(asyncAction(new AssetBuilder(this.Request)));
+        return (TBuilder) this;
+    }
+
+    [PublicAPI]
+    public TBuilder SetConversionBehaviors(Action<HtmlConversionBehaviorBuilder> action)
+    {
+        if (action == null) throw new ArgumentNullException(nameof(action));
+        action(new HtmlConversionBehaviorBuilder(this.Request));
+        return (TBuilder) this;
+    }
+
+    [PublicAPI]
+    public TBuilder SetConversionBehaviors(HtmlConversionBehaviors behaviors)
+    {
+        this.Request.ConversionBehaviors = behaviors ?? throw new ArgumentNullException(nameof(behaviors));
+        return (TBuilder) this;
+    }
+}

lib/Domain/Builders/BaseMergeBuilder.cs

@@ -0,0 +1,45 @@
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+
+using Gotenberg.Sharp.API.Client.Domain.Builders.Faceted;
+using Gotenberg.Sharp.API.Client.Domain.Requests;
+
+using JetBrains.Annotations;
+
+namespace Gotenberg.Sharp.API.Client.Domain.Builders;
+
+public abstract class BaseMergeBuilder<TRequest, TBuilder> : BaseBuilder<TRequest, TBuilder>
+    where TRequest : RequestBase
+    where TBuilder : BaseMergeBuilder<TRequest, TBuilder>
+{
+    protected readonly List<Task> AsyncTasks = new List<Task>();
+
+    /// <summary>
+    /// This tells gotenberg to have OfficeLibre perform the conversion.
+    /// If you set <see cref="MergeOfficeRequest.UseNativePdfFormat"/> to true
+    /// then gotenberg will hand the work off to unoconv to do the work
+    /// </summary>
+    [PublicAPI]
+    public TBuilder SetPdfFormat(PdfFormats format)
+    {
+        this.Request.Format = format;
+        return (TBuilder) this;
+    }
+
+    [PublicAPI]
+    public TBuilder WithAssets(Action<AssetBuilder> action)
+    {
+        if (action == null) throw new ArgumentNullException(nameof(action));
+        action(new AssetBuilder(this.Request));
+        return (TBuilder) this;
+    }
+
+    [PublicAPI]
+    public TBuilder WithAsyncAssets(Func<AssetBuilder, Task> asyncAction)
+    {
+        if (asyncAction == null) throw new ArgumentNullException(nameof(asyncAction));
+        this.AsyncTasks.Add(asyncAction(new AssetBuilder(this.Request)));
+        return (TBuilder) this;
+    }
+}