Changelog
What has changed in the FanBase SDK documentation.
What has changed here, newest first.
- New
Events, avatars, profile and Shopify
Three features move to live, each with a model page and the build.
- Events: listing and joining, event quests, score events, the community goal, the event leaderboard, and claiming prizes
- Avatars: the 2D stack, the 3D scene, the editor with its draft and one save, and another fan's avatar
- Profile: who is signed in, the XP bar, quest history and stats, and how the page is composed
A section for Shopify.
- FanBase on Shopify: every place the two connect, and which involve code
- Purchase rewards: what your app shows, the rule types, and the seven checks behind a purchase that paid nothing
- Sign in with Shopify: how a store customer and a fan become one account
- Storefront blocks: quests, the profile, the avatar and an account indicator as blocks in a Shopify theme. In build, rolling out to pilot stores first.
Changes to existing pages, to match the current packages:
- Every package tag now carries every feature,
latestincluded - Use
useViewerfor the signed-in fan's name and id. Membership is missing both for a fan who has not joined. - The membership gate now covers joining an event
- A store listing can ask for details of its own, on top of what its prize needs
- 719 display strings, up from 597, with events and the avatar editor added to the lookup
- The feature once exported as
Eventis nowQuestEvent. Upgrading.
- New
Battlepass, store, leaderboard and newsfeed
Four features move from planned to live, each documented to the same depth as quests: a model page for the vocabulary, then the build.
- Battlepass: seasons, free and premium lanes, claim one tier or all of them
- Store: listings in your own currencies, the purchase gate, Shopify orders, purchase history
- Leaderboard: the XP and quests boards, and the fan's own row
- Newsfeed: members-only posts, reactions and threaded comments
- Predictions: the lock, one final pick, the split and payout. Runs on quests today, moving to its own surface
New pages for the pieces they share.
- Linking accounts: connecting Discord, X, Twitch and more, with typed errors and expiry
- Prizes and inventory: prize detail forms, loot box claims, personalisation
- Membership: one gate across the battlepass, the store and the newsfeed
Corrections to existing pages, where they had fallen behind the package:
fetchRewardsonQuest.Provideris a flag, not a functionresolveQuestRewardChrometakes{ reward, quest }and returnsimageSrc- A fan's linked accounts come from
useLinkedSocials, not the profile, which omits expiry dates ParserandresolveMessageare imported from@xborglabs/fanbase-react- Template routing no longer uses
getApiType, which returns the submit path rather than a family. Every typed template sends{ text } - A bare
npm installnow works, and installs alatesttag that trailsalphaandbeta
Hooks, Components and API endpoints now cover every feature.
FanBase SDK documentation
Built to be read by an agent. The whole point of these pages. Hand them to Claude, Cursor or Codex and review the diff.
- Every page has a Markdown source and a copy button
- The whole site at /llms.txt and /llms-full.txt
- Any request asking for Markdown by content type gets Markdown back, not HTML
- Sequenced prompts to paste in Integrate with an agent
Create. Set your own colours, fonts, corner radii and shadow and watch neutral components take them. Get code returns what you built as:
- CSS custom properties
- A Tailwind
@themeblock - A React component using
useQuestsList()with your values applied
The showcase. One quest per template family, so you can see the requirement UI you write and the payload your submit sends:
- Poll, quiz, prediction, text answer
- Visit link, image upload, empty-body check-in
Three simulated partner products run that quest through the same state machine, so changing what is true about the fan moves all three at once.
The documentation itself, covering the live surface: fan sign-in, questing, rewards and claims.
- Installation, environment and a quickstart
- The concept model: how it fits together, tenancy, the quest model
- Seven guides, from sign-in through to using your own design system
- Reference for the provider, hooks, components, quest templates and endpoints
A check against stale pages. Every change runs a drift check that fails the build on:
- A hardcoded package version in prose
- An SDK export named here that the published package does not have
- A broken internal link