chore: enhance-customquery-type

[jacobfogolyan]

IN-3334

Description

Comparing examples on Vue Storefront docs on using custom Queries, when sending a customQuery with metadata, the type only allows Record<string, string> However in docs it is explained that you can send metadata as an object which this type doesn't allow.

What it currently supports

      getStores({
        customQuery: {
          getStoresData: 'set-store-data',
          metadata: 'entry1,entry2',
        },
      })

What is needed

     getStores({
        customQuery: {
          getStoresData: 'set-store-data',
          metadata: {
            key1: 'entry1',
            key22: 'entry2',
          },
        },
      })

If this change isn't made, then we would have to split the string by , rather than having metadata.objectKey.

How Has This Been Tested?

This was tested on an existing codebase

Checklist:

• I have read the CONTRIBUTING document.

Changelog

• v2 and mentioned all breaking changes in the public API.
• I have documented all new public APIs and made changes to existing docs mentioning the parts I've changed so they're up to date.

Tests

• I have written test cases for my code
• I have tested my Pull Request on production build and (to my knowledge) it works without any issues
• I have added tests to cover my changes.
• All new and existing tests passed.

Code standards

• My code follows the code style of this project.
• I have followed naming conventions

Docs

• My change requires a change to the documentation.
• I have updated the documentation accordingly.

[WojtekTheWebDev]

@jacobfogolyan to have it applied, please also bump the version in package.json. I can take care of the release after merging.