Skip to content

ConnectionKit v2.0.0

Choose a tag to compare

@afterxleep afterxleep released this 02 Sep 21:35
· 3 commits to main since this release

ConnectionKit v2.0.0 🎉

Major Release: Package Rename

This is a major release that renames the package from Connectable to ConnectionKit to avoid potential naming conflicts with iOS 26's upcoming Connectable framework for Wi-Fi Aware peer-to-peer connectivity.

🚨 Breaking Changes

  • Package renamed from Connectable to ConnectionKit
  • Import statements must be updated:
    // Before
    import Connectable
    
    // After  
    import ConnectionKit
  • Package URL changed to github.com/afterxleep/ConnectionKit

✨ What's New

  • Added LiveConnection type alias for the Connection class
  • Protocol remains Connectable (follows Apple's "-able" naming convention)
  • All existing functionality preserved
  • Improved documentation with migration guide

📦 Migration Guide

1. Update your Package.swift

dependencies: [
    .package(url: "https://github.com/afterxleep/ConnectionKit", .upToNextMajor(from: "2.0.0"))
]

2. Update your imports

Replace all instances of:

import Connectable

With:

import ConnectionKit

3. That's it!

All APIs remain the same. Your existing code will continue to work after updating the imports.

🔧 Technical Details

  • Source directory: Sources/ConnectionKit/
  • Test directory: Tests/ConnectionKitTests/
  • UserDefaults key: connectionkit.connection.state
  • Queue label: com.connectionkit.queue

📝 Notes

The protocol remains named Connectable as it follows Apple's naming conventions for protocols (Codable, Equatable, etc.). The LiveConnection type alias is available if you need to disambiguate between the protocol and class in your code.

🙏 Thank You

Thank you for using ConnectionKit! If you have any questions or issues with the migration, please open an issue on GitHub.