relay_flutter 1.2.0

Official Relay Delivery Platform Mobile SDK - Real-time WebSocket client for Flutter applications (iOS, Android, Web, Desktop)

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

1.0.0 2025-01-XX

Added

• Initial stable release of Relay Flutter SDK
• Real-time task tracking via WebSocket
• Automatic token provisioning and refresh
• 19 event types across task lifecycle, payments, and real-time updates
• Automatic reconnection with exponential backoff
• Heartbeat monitoring for connection health
• Offline message queuing
• Type-safe event streams using Dart Stream<T>
• Subscription preservation across reconnections
• Support for multiple simultaneous task tracking
• Comprehensive error handling with custom exceptions
• JWT token parsing utilities
• Full platform support (Android, iOS, Web, Desktop)
• Extensive documentation and examples

Event Types

• Task Lifecycle: TaskCreated, TaskOffered, TaskAssigned, TaskInProgress, TaskCompleted, TaskFailed, TaskCancelled, StageCompleted
• Payments: PaymentPending, PaymentReleased, PaymentDisputed, PaymentDisputeResolved
• Real-time: RiderLocationUpdate, NewTaskOffer
• Connection: ConnectionOpen, ConnectionClose, ConnectionError, ConnectionReconnecting, TokenExpiring

Configuration Options

• ReconnectConfig - Customizable reconnection behavior
• HeartbeatConfig - Configurable heartbeat monitoring
• RelayRealtimeClientOptions - Comprehensive client configuration

Core Features

• RelayRealtimeClient - Main SDK client
• listen(taskId) - Subscribe to task events
• stopListening(taskId) - Unsubscribe from task events
• getListeningTo() - Get tracked task IDs
• connect() / disconnect() - Manual connection control
• Event streams for all 19 event types
• Automatic token refresh before expiration
• Graceful disconnection with message flushing

Developer Experience

• Zero configuration required (sensible defaults)
• Type-safe API with full Dart type annotations
• Comprehensive dartdoc comments on all public APIs
• Example Flutter app demonstrating all features
• Migration guide for Browser SDK users

[Unreleased]

Planned Features

• Unit tests for all core components
• Integration tests with mock WebSocket server
• CI/CD pipeline for automated testing
• Performance benchmarks
• Additional example apps (maps integration, multi-task dashboard)
• Localization support for error messages

---

Version History

• 1.0.0 (2025-01-XX) - Initial stable release

Migration Guide

From Browser SDK (@relay-sdk/sdk-browser)

The Flutter SDK maintains API parity with the Browser SDK v2.0:

// Before (Browser SDK - TypeScript)
const relay = new RelayRealtimeClient({ getToken });
relay.listen('task-123');
relay.on('TASK_ASSIGNED', (event) => { /* ... */ });

// After (Flutter SDK - Dart)
final relay = RelayRealtimeClient(getToken: getToken);
await relay.listen('task-123');
relay.onTaskAssigned.listen((event) { /* ... */ });

Key differences:

• Use Stream<T> instead of EventEmitter (on() → onEventName.listen())
• Use Future<T> instead of Promise<T>
• Call dispose() when done (Flutter lifecycle pattern)
• Import from package:relay_flutter/relay_flutter.dart

Links

• GitHub Repository
• pub.dev Package
• Documentation
• API Reference