fightclub-meetplan-tracker
v1.0.2
Published
This package is developed by Fightclub and can be used to implement a datalayer tracking system
Readme
Meetplan Tracker
Modular, framework-agnostic data layer engine driven by a “meetplan” configuration. It attaches delegated DOM listeners, builds consistent event payloads (with optional standard parameters), and forwards them through pluggable adapters (e.g., window.dataLayer).
Highlights
- Meetplan-driven: nested groups, per-event selectors, dynamic data, guards.
- Lean runtime: one delegated listener per trigger; minimal DOM overhead.
- Adapters: browser
dataLayer, console, and buffer for tests/demos. - Validation: optional meetplan validation with structured issues.
When to use
- You want to centralise tracking logic in a reusable package.
- You need config-driven tracking that works across CMS-driven pages.
- You prefer debug-friendly, delegated listeners instead of per-element handlers.
Quick install
npm install fightclub-meetplan-trackerDocumentation
- Step-by-step integration, ConcreteCMS specifics, and examples are in the implementation guide:
docs/implementation-guide.md
API surface (at a glance)
- Core:
createTracker,tracker.register,tracker.initDelegatedEvents,tracker.push - Meetplan helpers:
defineMeetplan,mergeMeetplans,resolveMeetplanDefinition,validateMeetplanDefinition - Adapters:
createBrowserDataLayerAdapter,createConsoleAdapter,createBufferAdapter - Standard params:
createStandardParamsProvider
Roadmap (high level)
- Automatic session/engagement/scroll modules
- Built-in meetplan packs (forms, contact, global)
- Test suite and expanded docs
Contributions and feedback welcome.
