Document BuildJsScope model and split tracking scripts#601
Draft
promptless-for-oss wants to merge 1 commit into
Draft
Document BuildJsScope model and split tracking scripts#601promptless-for-oss wants to merge 1 commit into
promptless-for-oss wants to merge 1 commit into
Conversation
Documents the JS build scope model from mautic/mautic#16660: the BuildJsScope enum, BuildJsEvent::appendJsForScope()/acceptsScope(), the /mautic-essential.js and /mautic-tracking.js endpoints, client-side runtime globals, and the backward-compatibility impact on legacy appendJs() subscribers.
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
2 participants
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.
Updates the MauticJS tracking script developer page (
docs/mauticjs_api/tracking_script.rst) to document the JS build scope model introduced in mautic/mautic#16660 ("Split mtc.js into essential and tracking scripts", MTC-11100).New developer-facing surface documented:
Mautic\CoreBundle\Event\BuildJsScopeenum (RUNTIME,ESSENTIAL,TRACKING).BuildJsEvent::appendJsForScope($js, BuildJsScope $scope, $section = '')andacceptsScope(BuildJsScope $scope): bool, with plugin-style PHP subscriber examples.appendJs()now delegates toappendJsForScope()withBuildJsScope::TRACKING, plus a backward-compatibility warning (with argument-position migration guidance) thatappendJs()-only subscribers are excluded from/mautic-essential.js./mautic-essential.js,/mautic-tracking.js,/mtc.js) and their scope mappings.MauticJS.runtimeReady,trackingEnabled,requestWithCredentials) and themauticEssentialReadyevent, with a safe dual-path readiness guard example.Source PR: mautic/mautic#16660
This documentation update was prepared by Promptless.