@W-14901147: Shopper SEO hook

[alexvuong]

Description

This PR added query hooks for Shopper SEO APIs that has been added into commerce-sdk-isomorphic v1.12.0

Types of Changes

• Bug fix (non-breaking change that fixes an issue)
• New feature (non-breaking change that adds functionality)
• Documentation update
• Breaking change (could cause existing functionality to not work as expected)
• Other changes (non-breaking changes that does not fit any of the above)

Breaking changes include:

• Removing a public function or component or prop
• Adding a required argument to a function
• Changing the data type of a function parameter or return value
• Adding a new peer dependency to package.json

Changes

• (change1)

How to Test-Drive This PR

For testing purpose of this API, I've added redirects in BM that will used in the template Home page.

Source: /sample-product
Destination: /sample-product-redirected

• check out code
• npm ci at root
• npm start to start up Retail app
• Navigate to home page http://localhost:3000. Confirm that Shopper SEO useUrlMapping returns the data in the browser console

{
  copySourceParams: false,
  destinationUrl: '/sample-product-redirected',
  statusCode: '301'
}

Checklists

General

• Changes are covered by test cases
• CHANGELOG.md updated with a short description of changes (not required for documentation updates)

Accessibility Compliance

You must check off all items in one of the follow two lists:

• There are no changes to UI

or...

• Changes were tested with a Screen Reader (iOS VoiceOver or Android Talkback) and had no issues
• Changes comply with WCAG 2.0 guidelines levels A and AA
• Changes to common UI patterns and interactions comply with WAI-ARIA best practices

Localization

• Changes include a UI text update in the Retail React App (which requires translation)

[vmarta]

+1 from me. Had a question though about showing example usage.

And as an aside: maybe it's just me.. I found the code not really readable 😅 Maybe it's because of the typing. Perhaps the library is also really doing complex things.. 🤷 But anyways, other files are already coded in a similar way.

[vmarta]

After this test code is removed, will the retail-react-app show an example of how to really use useUrlMapping?

For example, right now I don't know whether I'll need to update my routes. Where should I call useUrlMapping?

I think it would be good if we can leave commented code somewhere, as a best practice on how to use this url mapping feature.

[alexvuong]

@vmarta I think useUrlMapping is like any other query hooks in the library. You can certainly call it any where you want in the app as long as you know which parameters to pass in the hook. (we currently do not have any examples for unused hooks in commerce-react)
In addition, we will start the Support ShopperSEO url mapping work soon, I think we will have more context to document there.