Skip to content

AI_Index

Ahmed Abbas edited this page Apr 19, 2026 · 4 revisions

JavaScript SDK Wiki — AI Agent Index

This index helps AI agents find the right documentation page without reading the entire wiki. Read this file first, then load only the specific pages relevant to your task.

Page Origin

This wiki contains two types of pages:

  • Shared docs (lowercase-hyphenated filenames) — Synced from the canonical source in the backend repo at backend/public/js/tracking/full-stack-docs/ (concepts/ and guides/ subdirs). These cover cross-SDK concepts and are identical across the JS and PHP SDK wikis. Do not edit them here — edits will be overwritten on the next sync.
  • JS-specific docs (CamelCase filenames) — Written for this SDK only: quickstart, installation, configuration, types, code examples, build.

Getting Started

Page When to read
How Convert Works High-level overview of the Convert platform and SDKs
Architecture Overview System architecture, module relationships, data flow
Data Model Reference Entity relationships: Experience, Variation, Feature, Variable, Goal, Audience, Location
Quickstart Overview Cross-SDK quickstart concepts before diving into JS-specific setup
Requirements & Constraints SDK limitations, environment requirements, known constraints

JavaScript SDK Reference

Page When to read
Quickstart Step-by-step JS/TS setup and first experiment
Installation Install via npm, yarn, or CDN
Initialization Import patterns, SDK Key init, static config, onReady()
Configuration Options Full SDK config reference
TypeScript Types TypeScript interfaces and type definitions
Code Examples Complete JS/TS examples for all SDK methods

Core Concepts (Shared)

Page When to read
Experiences & Variations A/B test structure, variation assignment, activation
Feature Flags Feature flag evaluation, variable values, feature status
Bucketing Algorithm Hash-based visitor assignment, traffic allocation, deterministic bucketing
Rule Evaluation & Targeting Audience matching, location matching, scheduling rules
Segments Visitor segmentation logic and custom segments
Data Management Data access layer, project config, entity lookups
Event System Event pub/sub, lifecycle hooks, custom events
API Communication & Tracking HTTP communication, config fetching, event tracking, queue management

How-To Guides (Shared)

Page When to read
Running Experiences End-to-end guide: activate experiments, get variations for a visitor
Running Features Feature flag usage: evaluate flags, get variable values
Tracking Conversions Goal tracking, conversion events, revenue tracking
Visitor Context & Properties Visitor identification, custom properties, cross-session persistence
Persistent DataStore Custom data store integration for visitor state persistence
Troubleshooting Common issues, debugging techniques, diagnostic steps

Edge & Integrations (Shared)

Page When to read
Cloudflare Workers Edge-side experimentation using Cloudflare Workers
LLM / AI Testing Server-side A/B testing for LLM prompts and responses via llms.txt

Contributing

Page When to read
Build & Custom Bundling Environment variables, custom builds, submodule integration

Module Dependency Map

ConvertSDK/Core
  ├── creates → Context
  ├── fetches config via → ApiManager
  ├── fires events via → EventManager
  └── uses → DataManager
Context
  ├── runs experiments via → ExperienceManager
  ├── runs features via → FeatureManager
  ├── accesses data via → DataManager
  └── releases queues via → ApiManager
DataManager
  ├── buckets via → BucketingManager
  ├── matches rules via → RuleManager
  ├── enqueues tracking via → ApiManager
  └── fires events via → EventManager

Clone this wiki locally