chore(repo): SDK overhaul (#28)

* feat(repo): Update instances of .io to .com

* feat(test): update tests to use compatible .net version for macOS

* fix(repo): prepare repo for nuget package upload

fix(repo): clarify code comments

feat(repo): add docbblocks to methods

* feat(repo): Use class input UrlboxOptions to improve typing

* feat(repo): Upgrade package from dotnet 2.0 -> 6.0

* feat(repo): Install dependencies for using env vars locally and in gh actions

* feat(repo): add webhook secret to Urlbox overload, and urlbox api endpoint CONSTS

* feat(repo): implement post sync and post async methods, including response types and custom deserializer

* feat(repo): add tests for render and render async endpoints for success and failure cases

fix(repo): fix blockUrls to be arr

* fix(repo): ensure strings are included in array string representations

* fix(repo): change cookies to obj and fix string interpretation of array

* fix(repo): update cookie type to be tighter to string OR string[]

refactor(repo): update urlboxoptions types

refactor(repo): split classes into their own files

* feat(repo): add a fromCredentials static method, and a webhook verifier method

refactor(repo): make global usings and organise resources and policies into dirs

* fix(repo): update validator to handle header edge cases

* feat(repo): add contribution guide including how to set env vars for test

refactor(readme): update readme with new usage examples including new methods

refactor(repo): update readme with static fromcredentials example, fix test warnings

* fix(repo): ensure options only accepts one of html or url but not both

refactor(repo): move urlboxoptions tests to own file

* feat(repo): add metadata/side renders as types to sync response, with resource tests and test for deserializer in render()

* fix(repo): make download method throw error with urlbox error message

* fix(repo): update urlbox sln to recognise the urlbox.csproj file

chore(repo): remove unused imports

add test to urlboxoptions

fix(repo): seal urlbox class

make urlbox values readonly private, remove unused webhookSecret which only gets consumed in UrlboxWebhookValidator

Implement getUrlboxErrorMessage, which extracts from err message in headers

chore(tests): cleanup tests

chore(repo): place classes into file namespaces

refactor(repo): implement abstract urlbox response

* feat(repo): implement takeScreenshot

chore(repo): capitalise verifywebhooksignature method

chore(repo): reorder methods into categories with public/private

* feat(repo): create Urlbox interface + factory for Dependency injection

* feat(tests): Add tests for checking Urlbox can be instantiated via DI for singleton/request/transient

* feat(tests): enable parallel testing

* feat(repo): add helper methods takemp4 takepdf takewithmeta takemobile and takefullpage

feat(repo):  update the readme WIP

feat(repo): update readme

* feat(repo): add section on render links and the api reference in readme:

fix(repo): add webhookUrl to tests

chore(repo): add note on DI in readme

refactor(repo): verifyWebhookSignature returns the full reponse object as a type instead of bool

chore(repo): move resources into their own dirs

* feat(repo): create an options builder for fluent options creation, with validation

* feat(repo): add in tests for validating screenshot options

* feat(repo): implement validation for engine version

refactor(repo): update readme to include usage of the urlbox options builder

* feat(repo): upgrade package version to 2.0.0, add changelog to readme

chore(repo): add changelog t TOC

refactor(repo): proof read repo

fix(repo): add gh image not showing in repo variant of readme

chore(repo): remove old xunit tests

fix(readme): replace occurrences of screenshotting with rendering

fix(readme): add explanation for getting project keys with screenshot

* fix(repo): rename namespace from screenshots to UrlboxSDK

chore(repo): rename GenerateUrlboxUrl() to GenerateRenderLink()

fix(readme): update comments in JSON to use #

chore(repo): rename GenerateUrlboxUrl() to GenerateRenderLink()

fix(readme): update s3 comment, replace lowercased .render with .Render

* feat(repo): add signed and unsigned variants of render link calls

refactor(repo): GetStatus() now takes a render ID instead of the full status URL

* fix(repo): update snakeCaseNamingPolicy with tests

* feat(repo): introduce UrlboxException, thrown on err with more meaningful information

* fix(repo): update urlboxexception to not use init

* fix(repo): wip - enable nullable on project, introduce enums, tests passing

chore(repo): organise files into directory structure

* fix(repo): handle nullable warnings that came out from enabling nullable in project

* feat(repo): add final enum types to options

chore(repo): cleanup use of this. and reserved keywords

* fix(repo): make ints nullable in options

* feat(repo): add ability to override base url, with tests

* feat(repo): add ability to use Render() and RenderAsync() with a dictionary instead of UrlboxOptions

chore(repo): rename urlgenerator to renderLinkGenerator

chore(repo): change core proj to urlboxSDK to match namespace

* fix(repo): rename target project for tests

chore(repo): move webhook tests to own file

* feat(repo): add tests for getstatus

chore(repo): reorganise project to not use redundant files/folders, split out classes where needed

chore(repo): remove unused nested urlbox dir

* feat(repo): add an extension method for DI easy injectionwhich takes an IOptions (UrlboxConfig)

chore(repo): split error into its own response file

refactor(repo): remove redundant webhookerror for generic UrlboxError

refactor(repo): place urlbox in main namespace, and make quality validated double

chore(repo): move di test into dir

* feat(repo): add a class to mock http requests with use of moq

chore(repo): linting and adding namespaces where missing

* feat(repo): add partial class to implement constructor for the quicktype generated urlboxoptions class

* feat(repo): add internal constructor for testing, which allows mocking http client

* feat(repo): extract value validation logic for reusability

refactor(repo): refactor repo+tests to be compatible with new quicktype generated urlboxOptions class

refactor(repo): move validation logic from builder into urlboxoptionsvalidation class

chore(repo): move main urlbox class to parent dir

* feat(repo): make render links signed by default

chore(repo): keep usage of typing over var consistent

chore(repo): improve test coverage

refactor(repo): remove custom types now that quicktype strictly turns boolikes etc etc into a single type

chore(repo): test update with ssl

* feat(repo): update the readme with the new DI instructions

* fix(repo): move private methods in urlbox to bottom of file, add overload for makepost to serialise UrlboxOptions with quicktyped serializer

refactor(repo): prune readme to make shorter, validate examples

* feat(repo): add example for fail on options

* chore(repo): ensure images show in readme, add example outputs

* chore(repo): add examples to TOC

* chore(repo): remove full page and mobile helper methods

* chore(repo): add examples for full page and mobile

* feat(repo): implement extraction methods for side formats

* feat(repo): update readme with extraction methods and how to use IDictionary overload

feat(repo): add trivial change to test actions

fix(repo): add missing awaits to tests

* fix(repo): ensure nullable fields dont show up in render response

* feat(repo): ensure user agent is added to each request

* feat(repo): add gh test running workflow

chore(repo): remove tmp comment line

* feat(repo): add in a new project showing example and webhooks

* fix(repo): ensure null values dont show in responses

refactor(readme): update readme to reflect new example webhook project

chore(repo): remove format arg from render links as can just use options.Format

fix(repo): fix failing test

* feat(repo): add deployment workflow less deploy step

* feat(repo): add in push to nuget

chore(repo): change on push syntax to match other repos

* refactor(repo): comment out deploy step and test release step in deploy_to_nuget action

* refactor(repo): add release please configs

* refactor(repo): use latest ubuntu to stop warning

* refactor(repo): update release please action to latest

* refactor(repo): remove release type

* chore(repo): trivial change in readme to trigger release-please

* refactor(repo): change * for . in root def for release please config

* chore(repo): trivial change in readme to trigger release-please

* refactor(repo): add annotations for release please auto-versioning

* refactor(repo): add back in deploy step less nuget push

* refactor(repo): run deploy job on push to release-please-test, not on pr close

* chore(release-please-test): release 1.1.0

* refactor(repo): trivial change to readme to test release

* chore(release-please-test): release 1.2.0

* refactor(repo): ensure release step outputs to deploy step in nuget action

* chore(release-please-test): release 1.3.0

* refactor(repo): ensure release step outputs to deploy step in nuget action

* chore(release-please-test): release 1.4.0

* refactor(repo): trivial change to readme to test release

* chore(release-please-test): release 1.5.0

* refactor(repo): update versions back to 1.0.2

* chore(release-please-test): release 1.1.0 (#24)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* chore(release-please-test): release 1.2.0 (#25)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* chore(release-please-test): release 1.3.0 (#26)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* chore(repo): ensure deploy action only runs when merging to master, add in nuget pub step

* chore(repo): remove target branch from deploy action

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

.github/workflows/deploy_to_nuget.yml

@@ -41,8 +41,7 @@ jobs:
       - name: Create Release
         id: create_release
         uses: googleapis/release-please-action@v4
-        with:
-          target-branch: release-please-test
+
     outputs:
       release_created: ${{ steps.create_release.outputs.release_created }}