Skip to main content

​
Migration Overview

This section contains guides for upgrading between Fanfare SDK versions and migrating between different integration approaches.

​
Migration Guides

GuideDescription
V1 to V2Upgrading from SDK v1.x to v2.x
React to SolidMoving from React hooks to Solid widgets
Custom to WidgetsReplacing custom UIs with widgets
ChangelogVersion history and release notes

​
Version Compatibility

SDK VersionCore PackageReact PackageSolid Package
2.x^2.0.0^2.0.0^2.0.0
1.x^1.0.0^1.0.0N/A

​
When to Migrate

Consider upgrading when:
  • New features - Access to latest distribution types and functionality
  • Performance improvements - Better bundle size and runtime performance
  • Bug fixes - Resolved issues from previous versions
  • Security updates - Critical security patches
  • Deprecation warnings - APIs scheduled for removal

​
Migration Strategy

​
1. Review Breaking Changes

Before upgrading, review the changelog and breaking changes: 
# Check current version
npm list @waitify-io/fanfare-sdk-core

# View changelog
npm view @waitify-io/fanfare-sdk-core changelog

​
2. Update Dependencies

Update all Fanfare packages together: 
# Update all Fanfare packages
npm update @waitify-io/fanfare-sdk-core @waitify-io/fanfare-sdk-react

# Or install specific versions
npm install @waitify-io/fanfare-sdk-core@^2.0.0 @waitify-io/fanfare-sdk-react@^2.0.0

​
3. Fix TypeScript Errors

After updating, run TypeScript compilation to find breaking changes: 
# Run type checking
npx tsc --noEmit

# Fix errors based on migration guide

​
4. Test Thoroughly

Test all distribution flows:
  • Queue entry and admission
  • Draw entry and results
  • Auction bidding
  • Waitlist signup
  • Timed release window
  • Experience journey flow

​
5. Monitor Production

After deploying:
  • Monitor error rates
  • Check analytics for conversion changes
  • Review user feedback

​
Getting Help

If you encounter issues during migration:
  1. Check the changelog for known issues and workarounds
  2. Review TypeScript errors for guidance on API changes
  3. Search GitHub issues for similar problems
  4. Contact support for critical migration issues

​
Deprecation Policy

Fanfare follows semantic versioning:
  • Major versions (x.0.0) - May contain breaking changes
  • Minor versions (0.x.0) - New features, backward compatible
  • Patch versions (0.0.x) - Bug fixes only
Deprecated APIs are marked with:
  • JSDoc @deprecated tags
  • Console warnings in development
  • TypeScript deprecation notices
Deprecated APIs are supported for at least one major version before removal.