fix: apply custom encoder to base64 parameters

[sherwinski]

Description

Before this PR, the encoder buildParams option would only be applied to the non-base64 parameters (i.e. parameters whose values did not end in 64). After this PR, the same encoder will be applied to base64 parameters as well.

It also adds an optional parameter key to the encoder which allows users to specify encoding logic conditional to the parameter key. This is helpful if users wish to encode base64 and non-base64 parameters differently.

Checklist

• [x] Read the contributing guidelines.
• [x] Each commit follows the Conventional Commit spec format.
• [x] Update the readme (if applicable).
• [] Update or add any necessary API documentation (if applicable)
• [x] All existing unit tests are still passing (if applicable).
• [] Add some steps so we can test your bug fix or feature (if applicable).
• [x] Add new passing unit tests to cover the code introduced by your PR (if applicable).
• [] Any breaking changes are specified on the commit on which they are introduced with BREAKING CHANGE in the body of the commit.
• [] If this is a big feature with breaking changes, consider opening an issue to discuss first. This is completely up to you, but please keep in mind that your PR might not be accepted.

[commit-lint[bot]]

Bug Fixes

• apply custom encoder to base64 parameters (0e96db5)

Tests

• add case for custom encoding base64 parameters (a696259)
• add case for custom encoding conditional on parameter key (fb5dcb7)
• check if optional parameter is potentially undefined (5e5eb53)
• add cases for custom encoding the image path (3c2c00f)
• add TS cases for sanitizePath and buildParams options (b9653e6)

Features

• add optional key parameter to custom encoder when encoding k,v pairs (d0b3076)

Documentation

• add example describing parameter custom encoding (da45e4c)

Chore

• add TS definitions for sanitizePath and buildParam options (4682b36)
• update test spec description (8804a24)

Contributors

sherwinski

Commit-Lint commands

You can trigger Commit-Lint actions by commenting on this PR: - `@Commit-Lint merge patch` will merge dependabot PR on "patch" versions (X.X.Y - Y change) - `@Commit-Lint merge minor` will merge dependabot PR on "minor" versions (X.Y.Y - Y change) - `@Commit-Lint merge major` will merge dependabot PR on "major" versions (Y.Y.Y - Y change) - `@Commit-Lint merge disable` will desactivate merge dependabot PR - `@Commit-Lint review` will approve dependabot PR - `@Commit-Lint stop review` will stop approve dependabot PR

[sherwinski]

At the risk of making this PR lengthier, I patched in some missing TS definitions as well.

[imgix-git-robot]

:tada: This PR is included in version 3.8.0 :tada:

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot :package::rocket: