Skip to content

MIGRATION_GUIDE.md

Latest commit

 

History

History
83 lines (59 loc) · 3.32 KB

MIGRATION_GUIDE.md

File metadata and controls

83 lines (59 loc) · 3.32 KB
Raw

TraktKit Migration Guides

This document serves as an index to all migration guides for TraktKit version upgrades.

Available Migration Guides

v3.6.x to v3.7.0

Auth Lifecycle Rework + Paginated fetchAllPages Result

Fixes forced re-authentication for users whose access token expired:

  • Expired tokens are now a signed-in state (isSignedIn stays true) and refresh on demand
  • AuthenticationError.tokenExpired / .noStoredCredentials removed; expiry is AuthenticationState.isExpired, missing credentials are a nil state
  • Custom TraktAuthentication.getCurrentState() is now non-throwing and returns AuthenticationState?
  • checkToRefresh() renamed to refreshTokenIfNeeded()
  • Route.fetchAllPages() returns PagedFetchResult<Element> (read .items) instead of Set<Element>

Compiler-enforced; build to find every call site.

v3.1.x to v3.2.0

Error Type Renames

Improves error type naming for better clarity and consistency:

  • TraktSpecificError → TraktAPIError
  • TraktKitError → TraktClientError

Quick migration with find & replace. Compiler errors will guide you.

v1.x to v2.0

Async/Await Migration and API Restructure

Major rewrite introducing modern async/await API:

  • Completion handlers replaced with async/await
  • Resource-based API organization (.movies, .shows, .users)
  • Route-based pattern with chainable methods
  • Minimum iOS 16+, Swift 6.0 required

Comprehensive guide with before/after examples for all common patterns.

Quick Links

How to Use These Guides

  1. Check your current version - Run swift package show-dependencies or check your Package.swift
  2. Find your migration path - Select the guide(s) that cover your version upgrade
  3. Read the CHANGELOG - Get a quick overview of what changed
  4. Follow the migration guide - Detailed steps with code examples
  5. Test incrementally - Update and test as you go

Version History

Version Release Date Major Changes
3.7.0 2026-07-06 Auth lifecycle rework; fetchAllPages returns PagedFetchResult
3.6.1 2026-06-27 Route token refresh through the shared AuthCoordinator
3.6.0 2026-06-21 Added missing model properties
3.5.0 2026-05-27 Paginated watched endpoints
3.4.0 2026-05-26 sharedAuthCoordinator for sibling managers
3.3.0 2026-04-11 userAgent required on TraktManager.init
3.2.0 2026-02-25 Error type renames
3.1.1 2026-02-24 Bug fixes
3.1.0 2026-02-22 PKCE authentication support
3.0.0 2026-02-21 Removed completion handlers
2.0.0 2026-02-21 Async/await API, major rewrite
1.5.7 Earlier Legacy completion handler API

Need Help?

Contributing

Found an issue or have suggestions? Open an issue or submit a pull request!