DartStream Transmit Authentication Provider

Overview

The Transmit provider adds modular authentication capabilities to DartStream, following the same structure and technical approach as the Auth0 and Magic providers.

Features

• Passwordless or conventional Transmit authentication (based on Transmit API capabilities)
• Token management: secure storage, validation, renewal (if supported)
• Session management: active session tracking and validation
• Lifecycle event hooks: handle login/logout and other authentication events

Directory Structure

transmit/
    lib/
        src/
            ds_error_mapper.dartds_event_handlers.dart
            ds_session_manager.dartds_token_manager.dart
            ds_transmit_auth_export.dart
            ds_transmit_auth_provider.dart
        ds_transmit_auth_export.dart
        ds_transmit_auth_provider.dart
        CHANGELOG.md
        LICENSE
        manifest.yaml
        pubspec.yaml
        README.md

Key Dart Files

• lib/src/ds_error_mapper.dart: Maps Transmit-specific errors to standardized DartStream error codes.
• lib/src/ds_event_handlers.dart: Handles provider-related authentication events.
• lib/src/ds_session_manager.dart: Manages the user session lifecycle.
• lib/src/ds_token_manager.dart: Handles access token storage, retrieval, and renewal logic.
• lib/ds_transmit_auth_export.dart: Barrel export file for public APIs.
• lib/ds_transmit_auth_provider.dart: Transmit-specific provider class with main authentication logic.

DSTransmitAuthProvider

A Dart provider implementing the DSAuthProvider interface, using the Transmit Authentication SDK (transmit_dart_auth_sdk) for robust, modular authentication workflows in Dart/Flutter backends.

Features

• Authentication with username/password using Transmit API.
• Access & refresh token management via dedicated managers.
• Session tracking logic and helpers.
• Token verification endpoint support.
• Custom error mapping for predictable handling.
• Lifecycle event hooks for login/logout.

API Docs

Initialization

Future<void> initialize(Map<String, dynamic> config)

• Initialize with { apiKey, serviceId, region? }.
• Example:

await provider.initialize({
  'apiKey': 'your_api_key',
  'serviceId': 'your_service_id',
  'region': 'global',
});

Sign In

Future<void> signIn(String username, String password)

• Authenticates a user.
• Stores tokens, session, and user info on success.

Sign Out

Future<void> signOut()

• Logs out, clears session/token state.

Refresh Token

Future<String> refreshToken(String refreshToken)

• Exchanges refresh token for a new access token.

Verify Token

Future<bool> verifyToken([String? token])

• Checks validity of the (given/current) access token.

Getter, Hooks, and Unimplemented

• Future<DSAuthUser> getCurrentUser() – returns current user.
• Future<void> createAccount(...) and Future<DSAuthUser> getUser(...) – not supported (throw UnimplementedError).
• Future<void> onLoginSuccess(DSAuthUser user) and Future<void> onLogout() – override for custom lifecycle behavior.

User Docs / Onboarding

1. Add Dependency:
Add transmit_dart_auth_sdk in your pubspec.yaml.
2. Provider Setup:
Create and initialize DSTransmitAuthProvider with the necessary configuration.
3. Sign-In Flow:
Use signIn(username, password) to authenticate; access user and token state from the provider.
4. Session/Token Management:
Use refreshToken and verifyToken helpers to maintain sessions.
5. Sign Out:
Use signOut() to clear session state.
6. Error Handling:
Error messages are mapped to standard codes for easier handling (see Error Mapping in System Design).

System Design / Architecture

• Separation of Concerns:
• Errors (DSTransmitErrorMapper), tokens (DSTransmitTokenManager), sessions (DSTransmitSessionManager), and events (DSTransmitEventHandlers) are separate classes for modularity and clarity.
• Transmit SDK Integration:
• Uses TransmitAuthConfig and ApiClient for secure HTTP REST interaction and token lifecycle.
• Stateless Client Logic:
• All network methods hit the Transmit API directly, passing API key for auth, and maintain stateless operation via token/session managers.
• Extensible Events:
• onLoginSuccess and onLogout lifecycle hooks can be customized.
• Error Mapping:
• Transmit-specific error codes (e.g., INVALID_TOKEN, USER_NOT_FOUND) are mapped to your auth system’s error taxonomy for consistency.
• DSAuthProvider Compatibility:
• This provider is drop-in compatible with the DartStream auth ecosystem and can be used interchangeably with other providers.

Core API Methods

Project Files (Descriptions)

Notes

• Follow this structure and modular approach for maintainability and extensibility.
• Ensure all secrets and API keys are securely managed.
• Update dependencies and documentation as Transmit or DartStream evolves.