Repository navigation
Fix privacy banner option types for headless storefronts - #4138
Open
minwookshin wants to merge 1 commit into
Open
minwookshin wants to merge 1 commit into
minwookshin wants to merge 1 commit into
Conversation
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
WHY are these changes introduced?
Fixes #4069. Headless storefronts need to pass their public Storefront API token and root domains when reopening the privacy banner, but the current types reject those options.
WHAT is this pull request doing?
Allow the banner options on
showBanner()andshowPreferences(), preserving no-argument calls. Document the explicit headless configuration in the packaged analytics guide and add compile-time coverage for both methods.HOW to test your changes?
pnpm --filter @shopify/hydrogen typecheckpnpm --filter @shopify/hydrogen test:types --maxWorkers=2 --minWorkers=1— 142 files, 2,342 tests pass; no type errors.pnpm --filter @shopify/hydrogen libcheckThe new type tests reject the valid option calls before the change. The built declarations also expose the options. This changes types and guidance only; no live storefront or consent settings were changed.
Checklist