feat: make previewCookieName configurable and add useSanityPreviewCookie - #1511
Draft
parion wants to merge 1 commit into
Draft
feat: make previewCookieName configurable and add useSanityPreviewCookie#1511parion wants to merge 1 commit into
previewCookieName configurable and add useSanityPreviewCookie#1511parion wants to merge 1 commit into
Conversation
✅ Deploy Preview for nuxt-sanity-module ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
commit: |
parion
marked this pull request as draft
August 3, 2026 04:23
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
1 participant
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.
Summary
Resolves #1431. Makes the preview mode cookie name configurable via a new
visualEditing.previewCookieNameoption, and adds auseSanityPreviewCookiecomposable so apps can read the cookie (e.g. to protect routes when preview mode is not active).Changes
visualEditing.previewCookieNameoption (defaultsanity-preview-id) is threaded through the public runtime config, mirroring the existingkeepStegaOnCopyoption.server/routes/preview/enable.tsserver/routes/preview/disable.tsserver/routes/preview/proxy.tsplugins/visual-editing.server.tsuseSanityPreviewCookiecomposable reads the cookie value viauseSanityConfig(); auto-imported and exported from the composables barrel when visual editing is configured.SanityPublicRuntimeConfigandSanityResolvedConfig.Tests
test/unit/useSanityPreviewCookie.test.tscovering:176tests across unit/e2e/nuxt projects, plustest:typesandlint.Notes
The cookie is
httpOnly, souseSanityPreviewCookiereads server-side (SSR/middleware), which is where route protection happens. The issue author's suggestedusePreviewCookie()naming was adapted touseSanityPreviewCookieto match the module's composable conventions.