Improve type safety for SEO data utilities

[davidhousedev]

WHY are these changes introduced?

This PR brings more consistency to the typing of the seo data utilities. This preserves internal consistency within the module and will hopefully help folks in userland who bring the seo data utility module into their own repos.

WHAT is this pull request doing?

Previously, the collection and product seo data utilities in the demo store inferred the types of the data they returned. In contrast, other seo data utililties annotated the return type with the SeoConfig generic.

I realized that the product and collection utilities were using extracted functions for creating the jsonLd values, but those functions returned the incorrect type. I removed the unnecessary array typing and was then able to add the return typing to collection and product.

Checklist

• I've read the Contributing Guidelines
• I've considered possible cross-platform impacts (Mac, Linux, Windows)
• I've added a changeset if this PR contains user-facing or noteworthy changes
• I've added tests to cover my changes
• I've added or updated the documentation

[frehner]

From looking at the changes, it seems you're only making updates to the demo-store implementation, is that correct?

If so, then we don't need a changeset.

Unless you meant to update code in the Hydrogen library itself?

[davidhousedev]

@frehner ah, got it. I took a look at the releases and thought I saw changes to the demo store in there but I must have misunderstood :). I'll remove the changeset.

[frehner]

Ok, actually, turns out we do need a changeset; but you'll only need to add it to the demo-store template and not any of the packages. Sorry about that!

[juanpprieto]

Thanks @davidhousedev. Looks great. Let's merge after the changeset is back in 🙏🏼

[davidhousedev]

@frehner @juanpprieto I don't see demo-store on the list of available options when adding a changeset, is there something I'm missing here?

[frehner]

Hmm, sorry about this @davidhousedev

After talking a bit, it seems like the recommendation is to make a changeset for the cli package. We should probably document that somewhere.

[davidhousedev]

No worries @frehner ! Updated 👍🏻

[frehner]

Wait something seems weird here - are you targeting the correct branch to merge into? Github is saying Shopify:2023-01 but I think it should just be 2023-01, and should also be running some additional checks?

[davidhousedev]

@frehner I'm targeting the Shopify org repo from my fork, that's why Github is adding the Shopify: prefix. Is it possible that your github actions aren't configured to listen for PRs from forks?

I assumed that Github wouldn't let me push a branch or open a PR in the Shopify org since I'm not a contributor to the repo 🤔

[benjaminsehl]

since I'm not a contributor to the repo 🤔

I mean, obviously that was our first mistake 😉

[frehner]

Is it possible that your github actions aren't configured to listen for PRs from forks?

Good callout, I think you're right. One moment while I update our actions.

[frehner]

Ok, sorry again! @davidhousedev can you pull in the latest from shopify/hydrogen? I've updated our action config and they should run once you've pulled in and updated your PR. Thanks

[davidhousedev]

Gonna re-open this with a branch from my fork, so I can keep my forked 2023-01 up-to-date with the base