Repository navigation
docs: describe stored data, consent, and storage limits - #231
Merged
Merged
Conversation
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.
The README described what the module stores in a few scattered sentences. This adds a Privacy and consent section and documents the storage limits that affect production sites.
Privacy and consent:
utm:before-track, because a saved preference outlives consent that expires without a callback.captureWithoutCampaign: false, retention limits, and redacting the landing URL in a hook.Storage limits:
firstTouchandlastTouch.maxEntriesand usuallymaxAge.wwwand the apex domain keep separate histories. For long sales cycles, the README suggests sending the first touch to your server on the first visit and linking the later lead with a cookie your server sets, which Safari's seven-day limit does not cover.The Composable section now also says that the server renders the configured
trackingEnabledvalue, so displays of the tracking preference need<ClientOnly>just like displays of history. The click ID paragraph links to the new section instead of repeating it.Each limit and legal reference links its source: WebKit's tracking prevention page, MDN's storage quota page, Express's body-parser documentation, EUR-Lex, the EDPB, and the ICO. The entry size and the 150-entry figure come from measuring the JSON that
getAttribution()returns for seeded histories of realistic entries: 38.7 KB at 50 entries and 140 KB at 200.Validation:
pnpm format:checkandpnpm lint --max-warnings 0pass.